Installing Satellite Server in a disconnected network environment


Red Hat Satellite 6.17

Install and configure Satellite Server in a network without Internet access

Red Hat Satellite Documentation Team

Abstract

This guide describes how to install Red Hat Satellite in a disconnected network, perform initial configuration, and configure external services.

Providing feedback on Red Hat documentation

We appreciate your feedback on our documentation. Let us know how we can improve it.

Use the Create Issue form in Red Hat Jira to provide your feedback. The Jira issue is created in the Red Hat Satellite Jira project, where you can track its progress.

Prerequisites

Procedure

  1. Click the following link: Create Issue. If Jira displays a login error, log in and proceed after you are redirected to the form.
  2. Complete the Summary and Description fields. In the Description field, include the documentation URL, chapter or section number, and a detailed description of the issue. Do not modify any other fields in the form.
  3. Click Create.

Red Hat Offline Knowledge Portal

You can install the Red Hat Offline Knowledge Portal to access Red Hat documentation and search the Red Hat Knowledgebase offline in a restricted or secure network environment. For more information, see Red Hat Offline Knowledge Portal documentation.

Review the following prerequisites before you install Satellite Server.

For interactive instructions for performing the installation, you can use the Red Hat Satellite Installation Helper on the Red Hat Customer Portal. This application provides you with an interactive way to prepare installation instructions customized for your required Satellite version number and configuration. For more information, see Red Hat Satellite Installation Helper on the Red Hat Customer Portal.

1.1. System requirements

The following requirements apply to the networked base operating system:

  • x86_64 architecture
  • The latest version of Red Hat Enterprise Linux 9
  • 4-core 2.0 GHz CPU at a minimum
  • A minimum of 20 GB RAM is required for Satellite Server to function. In addition, a minimum of 4 GB RAM of swap space is also recommended. Satellite running with less RAM than the minimum value might not operate correctly.
  • A unique host name, which can contain lower-case letters, numbers, dots (.) and hyphens (-)
  • A current Red Hat Satellite subscription
  • Administrative user (root) access
  • Full forward and reverse DNS resolution using a fully-qualified domain name

Satellite only supports UTF-8 encoding. If your territory is USA and your language is English, set en_US.utf-8 as the system-wide locale settings. For more information about configuring system locale in Red Hat Enterprise Linux, see Configuring the system locale in Red Hat Enterprise Linux 9 Configuring basic system settings.

Your Satellite must have the Red Hat Satellite Infrastructure Subscription manifest in your Customer Portal. Satellite must have satellite-capsule-6.x repository enabled and synced. To create, manage, and export a Red Hat Subscription Manifest in the Customer Portal, see Creating and managing manifests for a connected Satellite Server in Subscription Central.

Satellite Server and Capsule Server do not support shortnames in the hostnames. When using custom certificates, the Common Name (CN) of the custom certificate must be a fully qualified domain name (FQDN) instead of a shortname. This does not apply to the clients of a Satellite.

Before you install Satellite Server, ensure that your environment meets the requirements for installation.

Satellite Server must be installed on a freshly provisioned system that serves no other function except to run Satellite Server. The freshly provisioned system must not have the following users provided by external identity providers to avoid conflicts with the local users that Satellite Server creates:

  • apache
  • foreman
  • foreman-proxy
  • postgres
  • pulp
  • puppet
  • redis
  • tomcat

Certified hypervisors

Satellite Server is fully supported on both physical systems and virtual machines that run on hypervisors that are supported to run Red Hat Enterprise Linux. For more information about certified hypervisors, see Certified Guest Operating Systems in Red Hat OpenStack Services on OpenShift, Red Hat Virtualization, Red Hat OpenShift Virtualization and Red Hat Enterprise Linux with KVM.

SELinux mode

SELinux must be enabled, either in enforcing or permissive mode. Installation with disabled SELinux is not supported.

Synchronized system clock

The system clock on the base operating system where you are installing your Satellite Server must be synchronized across the network. If the system clock is not synchronized, SSL certificate verification might fail. For example, you can use the Chrony suite for timekeeping. For more information, see Configuring time synchronization in Red Hat Enterprise Linux 9 Configuring basic system settings

FIPS mode

You can install Satellite on a Red Hat Enterprise Linux system that is operating in FIPS mode. You cannot enable FIPS mode after the installation of Satellite. For more information, see Switching RHEL to FIPS mode in Red Hat Enterprise Linux 9 Security hardening.

Note

Satellite supports DEFAULT and FIPS crypto-policies. The FUTURE crypto-policy is not supported for Satellite and Capsule installations. The FUTURE policy is a stricter forward-looking security level intended for testing a possible future policy. For more information, see Using system-wide cryptographic policies in Red Hat Enterprise Linux 9 Security hardening.

Inter-Satellite Synchronization (ISS)

In a scenario with air-gapped Satellite Servers, all your Satellite Servers must be on the same Satellite version for ISS Export Sync to work. ISS Network Sync works across all Satellite versions that support it. For more information, see Synchronizing Content Between Satellite Servers in Managing content.

1.2. Storage requirements

The following table details storage requirements for specific directories. These values are based on expected use case scenarios and can vary according to individual environments.

The runtime size was measured with Red Hat Enterprise Linux 7, 8, and 9 repositories synchronized.

Expand
Table 1.1. Storage requirements for a Satellite Server installation
DirectoryInstallation SizeRuntime Size

/var/log

10 MB

10 GB

/var/lib/pgsql

100 MB

20 GB

/usr

10 GB

Not Applicable

/opt/puppetlabs

500 MB

Not Applicable

/var/lib/pulp

1 MB

300 GB

For external database servers: /var/lib/pgsql with installation size of 100 MB and runtime size of 20 GB.

For detailed information on partitioning and size, see Disk partitions in Red Hat Enterprise Linux 9 Managing storage devices.

1.3. Storage guidelines

Consider the following guidelines when installing Satellite Server to increase efficiency.

  • If you mount the /tmp directory as a separate file system, you must use the exec mount option in the /etc/fstab file. If /tmp is already mounted with the noexec option, you must change the option to exec and re-mount the file system. This is a requirement for the puppetserver service to work.
  • Because most Satellite Server data is stored in the /var directory, mounting /var on LVM storage can help the system to scale.
  • Use high-bandwidth, low-latency storage for the /var/lib/pulp/ and PostgreSQL /var/lib/pgsql directories. As Red Hat Satellite has many operations that are I/O intensive, using high latency, low-bandwidth storage causes performance degradation.

You can use the storage-benchmark script to get this data. For more information on using the storage-benchmark script, see Impact of Disk Speed on Satellite Operations.

File system guidelines

  • Do not use the GFS2 file system as the input-output latency is too high.

Log file storage

Log files are written to /var/log/messages/, /var/log/httpd/, and /var/lib/foreman-proxy/openscap/content/. You can manage the size of these files using logrotate. For more information, see How to use logrotate utility to rotate log files.

The exact amount of storage you require for log messages depends on your installation and setup.

SELinux considerations for NFS mount

When the /var/lib/pulp directory is mounted using an NFS share, SELinux blocks the synchronization process. To avoid this, specify the SELinux context of the /var/lib/pulp directory in the file system table by adding the following lines to /etc/fstab:

nfs.example.com:/nfsshare  /var/lib/pulp  nfs  context="system_u:object_r:var_lib_t:s0"  1 2
Copy to Clipboard Toggle word wrap

If NFS share is already mounted, remount it using the above configuration and enter the following command:

# restorecon -R /var/lib/pulp
Copy to Clipboard Toggle word wrap

Duplicated packages

Packages that are duplicated in different repositories are only stored once on the disk. Additional repositories containing duplicate packages require less additional storage. The bulk of storage resides in the /var/lib/pulp/ directory. These end points are not manually configurable. Ensure that storage is available on the /var file system to prevent storage problems.

Symbolic links

You cannot use symbolic links for /var/lib/pulp/.

1.4. Supported operating systems

You can install the operating system from a disc, local ISO image, Kickstart, or any other method that Red Hat supports. Red Hat Satellite Server is supported on the latest version of Red Hat Enterprise Linux 9 that is available at the time when Satellite Server is installed. Previous versions of Red Hat Enterprise Linux including EUS or z-stream are not supported.

The following operating systems are supported by the installer, have packages, and are tested for deploying Satellite:

Expand
Table 1.2. Operating systems supported by satellite-installer

Operating System

Architecture

Notes

Red Hat Enterprise Linux 9

x86_64 only

 

Red Hat advises against using an existing system because the Satellite installer will affect the configuration of several components. Red Hat Satellite Server requires a Red Hat Enterprise Linux installation with the @Base package group with no other package-set modifications, and without third-party configurations or software not directly necessary for the direct operation of the server. This restriction includes hardening and other non-Red Hat security software. If you require such software in your infrastructure, install and verify a complete working Satellite Server first, then create a backup of the system before adding any non-Red Hat software.

Red Hat does not support using the system for anything other than running Satellite Server.

1.5. Supported browsers

Satellite supports recent versions of Firefox and Google Chrome browsers.

The Satellite web UI and command-line interface support English, French, Japanese, Korean, and Simplified Chinese.

1.6. Port and firewall requirements

For the components of Satellite architecture to communicate, ensure that the required network ports are open and free on the base operating system. You must also ensure that the required network ports are open on any network-based firewalls.

Use this information to configure any network-based firewalls. Note that some cloud solutions must be specifically configured to allow communications between machines because they isolate machines similarly to network-based firewalls. If you use an application-based firewall, ensure that the application-based firewall permits all applications that are listed in the tables and known to your firewall. If possible, disable the application checking and allow open port communication based on the protocol.

Integrated Capsule

Satellite Server has an integrated Capsule and any host that is directly connected to Satellite Server is a Client of Satellite in the context of this section. This includes the base operating system on which Capsule Server is running.

Clients of Capsule

Hosts which are clients of Capsules, other than Satellite’s integrated Capsule, do not need access to Satellite Server. For more information on Satellite Topology and an illustration of port connections, see Capsule Networking in Overview, concepts, and deployment considerations.

Required ports can change based on your configuration.

The following tables indicate the destination port and the direction of network traffic:

Expand
Table 1.3. Satellite Server incoming traffic
Destination PortProtocolServiceSourceRequired ForDescription

53

TCP and UDP

DNS

DNS Servers and clients

Name resolution

DNS (optional)

67

UDP

DHCP

Client

Dynamic IP

DHCP (optional)

69

UDP

TFTP

Client

TFTP Server (optional)

 

443

TCP

HTTPS

Capsule

Red Hat Satellite API

Communication from Capsule

443, 80

TCP

HTTPS, HTTP

Client

Global Registration

Registering hosts to Satellite

Port 443 is required for registration initiation, uploading facts, and sending installed packages and traces

Port 80 notifies Satellite on the /unattended/built endpoint that registration has finished

443

TCP

HTTPS

Red Hat Satellite

Content Mirroring

Management

443

TCP

HTTPS

Red Hat Satellite

Capsule API

Smart Proxy functionality

443, 80

TCP

HTTPS, HTTP

Capsule

Content Retrieval

Content

443, 80

TCP

HTTPS, HTTP

Client

Content Retrieval

Content

1883

TCP

MQTT

Client

Pull based REX (optional)

Content hosts for REX job notification (optional)

5910 – 5930

TCP

HTTPS

Browsers

Compute Resource’s virtual console

 

8000

TCP

HTTP

Client

Provisioning templates

Template retrieval for client installers, iPXE or UEFI HTTP Boot

8000

TCP

HTTPS

Client

PXE Boot

Installation

8140

TCP

HTTPS

Client

Puppet agent

Client updates (optional)

9090

TCP

HTTPS

Red Hat Satellite

Capsule API

Smart Proxy functionality

9090

TCP

HTTPS

Client

OpenSCAP

Configure Client (if the OpenSCAP plugin is installed)

9090

TCP

HTTPS

Discovered Node

Discovery

Host discovery and provisioning (if the discovery plugin is installed)

9090

TCP

HTTPS

Client

Pull based REX (optional)

Content hosts for REX job notification (optional)

Any host that is directly connected to Satellite Server is a client in this context because it is a client of the integrated Capsule. This includes the base operating system on which a Capsule Server is running.

A DHCP Capsule performs ICMP ping or TCP echo connection attempts to hosts in subnets with DHCP IPAM set to find out if an IP address considered for use is free. This behavior can be turned off using satellite-installer --foreman-proxy-dhcp-ping-free-ip false.

Note

Some outgoing traffic returns to Satellite to enable internal communication and security operations.

Expand
Table 1.4. Satellite Server outgoing traffic
Destination PortProtocolServiceDestinationRequired ForDescription
 

ICMP

ping

Client

DHCP

Free IP checking (optional)

7

TCP

echo

Client

DHCP

Free IP checking (optional)

22

TCP

SSH

Target host

Remote execution

Run jobs

22, 16514

TCP

SSH SSH/TLS

Compute Resource

Satellite originated communications, for compute resources in libvirt

 

53

TCP and UDP

DNS

DNS Servers on the Internet

DNS Server

Resolve DNS records (optional)

53

TCP and UDP

DNS

DNS Server

Capsule DNS

Validation of DNS conflicts (optional)

53

TCP and UDP

DNS

DNS Server

Orchestration

Validation of DNS conflicts

68

UDP

DHCP

Client

Dynamic IP

DHCP (optional)

80

TCP

HTTP

Remote repository

Content Sync

Remote repositories

389, 636

TCP

LDAP, LDAPS

External LDAP Server

LDAP

LDAP authentication, necessary only if external authentication is enabled. The port can be customized when LDAPAuthSource is defined

443

TCP

HTTPS

Satellite

Capsule

Capsule

Configuration management

Template retrieval

OpenSCAP

Remote Execution result upload

443

TCP

HTTPS

Amazon EC2, Azure, Google GCE

Compute resources

Virtual machine interactions (query/create/destroy) (optional)

443

TCP

HTTPS

Capsule

Content mirroring

Initiation

443

TCP

HTTPS

Infoblox DHCP Server

DHCP management

When using Infoblox for DHCP, management of the DHCP leases (optional)

623

  

Client

Power management

BMC On/Off/Cycle/Status

5000

TCP

HTTPS

OpenStack Compute Resource

Compute resources

Virtual machine interactions (query/create/destroy) (optional)

5900 – 5930

TCP

SSL/TLS

Hypervisor

noVNC console

Launch noVNC console

7911

TCP

DHCP, OMAPI

DHCP Server

DHCP

The DHCP target is configured using --foreman-proxy-dhcp-server and defaults to localhost

ISC and remote_isc use a configurable port that defaults to 7911 and uses OMAPI

8443

TCP

HTTPS

Client

Discovery

Capsule sends reboot command to the discovered host (optional)

9090

TCP

HTTPS

Capsule

Capsule API

Management of Capsules

1.7. AWS Requirements

Installing and running Satellite Server and Capsule Servers on Amazon Web Services (AWS) has additional requirements to your environment.

Amazon Web Service requirements

  • Use Storage requirements in Installing Satellite Server in a connected network environment to understand and assign the correct storage to your AWS EBS volumes. See also an AWS storage optimized instance for further guidance.
  • Create EBS volumes for directories expected to contain larger amounts of data like /var/lib/pulp and ensure they are correctly mounted on start-up and before continuing the installation.
  • Optional: Store other data on a separate EBS volume.
  • If you want Satellite Server and Capsule Server to communicate using external DNS hostnames, open the required ports for communication in the AWS Security Group that is associated with the instance.

AWS permission requirements

  • Create and access Red Hat Enterprise Linux images in AWS
  • Edit network access in AWS Security
  • Create EC2 instances and EBS volumes
  • Launch EC2 instances
  • Import and export of virtual machines in AWS
  • Usage of AWS Direct Connect

Satellite requirements

Ensure that your Amazon EC2 instance meets or exceeds requirements for Satellite:

Red Hat Cloud prerequisites

Additional resources

Capsules and Content Hosts that are clients of a Satellite Server’s internal Capsule require access through Satellite’s host-based firewall and any network-based firewalls.

Use this procedure to configure the host-based firewall on the system that Satellite is installed on, to enable incoming connections from Clients, and to make the configuration persistent across system reboots. For more information on the ports used, see Port and firewall requirements in Installing Satellite Server in a connected network environment.

Procedure

  1. Open the ports for clients on Satellite Server:

    # firewall-cmd \
    --add-port="8000/tcp" \
    --add-port="9090/tcp"
    Copy to Clipboard Toggle word wrap
  2. Allow access to services on Satellite Server:

    # firewall-cmd \
    --add-service=dns \
    --add-service=dhcp \
    --add-service=tftp \
    --add-service=http \
    --add-service=https \
    --add-service=puppetmaster
    Copy to Clipboard Toggle word wrap
  3. Make the changes persistent:

    # firewall-cmd --runtime-to-permanent
    Copy to Clipboard Toggle word wrap

Verification

  • Enter the following command:

    # firewall-cmd --list-all
    Copy to Clipboard Toggle word wrap

For more information, see Using and configuring firewalld in Red Hat Enterprise Linux 9 Configuring firewalls and packet filters.

1.9. Verifying DNS resolution

Verify the full forward and reverse DNS resolution using a fully-qualified domain name to prevent issues while installing Satellite.

Procedure

  1. Ensure that the host name and local host resolve correctly:

    # ping -c1 localhost
    # ping -c1 `hostname -f` # my_system.domain.com
    Copy to Clipboard Toggle word wrap

    Successful name resolution results in output similar to the following:

    # ping -c1 localhost
    PING localhost (127.0.0.1) 56(84) bytes of data.
    64 bytes from localhost (127.0.0.1): icmp_seq=1 ttl=64 time=0.043 ms
    
    --- localhost ping statistics ---
    1 packets transmitted, 1 received, 0% packet loss, time 0ms
    rtt min/avg/max/mdev = 0.043/0.043/0.043/0.000 ms
    
    # ping -c1 `hostname -f`
    PING hostname.gateway (XX.XX.XX.XX) 56(84) bytes of data.
    64 bytes from hostname.gateway (XX.XX.XX.XX): icmp_seq=1 ttl=64 time=0.019 ms
    
    --- localhost.gateway ping statistics ---
    1 packets transmitted, 1 received, 0% packet loss, time 0ms
    rtt min/avg/max/mdev = 0.019/0.019/0.019/0.000 ms
    Copy to Clipboard Toggle word wrap
  2. To avoid discrepancies with static and transient host names, set all the host names on the system by entering the following command:

    # hostnamectl set-hostname name
    Copy to Clipboard Toggle word wrap

For more information, see Changing a hostname using hostnamectl in Red Hat Enterprise Linux 9 Configuring and managing networking.

Warning

Name resolution is critical to the operation of Satellite. If Satellite cannot properly resolve its fully qualified domain name, tasks such as content management, subscription management, and provisioning will fail.

If your Satellite deployment includes more than 5000 hosts, you can use predefined tuning profiles to improve performance of Satellite.

Note that you cannot use tuning profiles on Capsules.

You can choose one of the profiles depending on the number of hosts your Satellite manages and available hardware resources.

The tuning profiles are available in the /usr/share/foreman-installer/config/foreman.hiera/tuning/sizes directory.

When you run the satellite-installer command with the --tuning option, deployment configuration settings are applied to Satellite in the following order:

  1. The default tuning profile defined in the /usr/share/foreman-installer/config/foreman.hiera/tuning/common.yaml file
  2. The tuning profile that you want to apply to your deployment and is defined in the /usr/share/foreman-installer/config/foreman.hiera/tuning/sizes/ directory
  3. Optional: If you have configured a /etc/foreman-installer/custom-hiera.yaml file, Satellite applies these configuration settings.

Note that the configuration settings that are defined in the /etc/foreman-installer/custom-hiera.yaml file override the configuration settings that are defined in the tuning profiles.

Therefore, before applying a tuning profile, you must compare the configuration settings that are defined in the default tuning profile in /usr/share/foreman-installer/config/foreman.hiera/tuning/common.yaml, the tuning profile that you want to apply and your /etc/foreman-installer/custom-hiera.yaml file, and remove any duplicated configuration from the /etc/foreman-installer/custom-hiera.yaml file.

default

Number of hosts: 0 – 5000

RAM: 20G

Number of CPU cores: 4

medium

Number of hosts: 5001 – 10000

RAM: 32G

Number of CPU cores: 8

large

Number of hosts: 10001 – 20000

RAM: 64G

Number of CPU cores: 16

extra-large

Number of hosts: 20001 – 60000

RAM: 128G

Number of CPU cores: 32

extra-extra-large

Number of hosts: 60000+

RAM: 256G

Number of CPU cores: 48+

Procedure

  1. Optional: If you have configured the custom-hiera.yaml file on Satellite Server, back up the /etc/foreman-installer/custom-hiera.yaml file to custom-hiera.original. You can use the backup file to restore the /etc/foreman-installer/custom-hiera.yaml file to its original state if it becomes corrupted:

    # cp /etc/foreman-installer/custom-hiera.yaml \
    /etc/foreman-installer/custom-hiera.original
    Copy to Clipboard Toggle word wrap
  2. Optional: If you have configured the custom-hiera.yaml file on Satellite Server, review the definitions of the default tuning profile in /usr/share/foreman-installer/config/foreman.hiera/tuning/common.yaml and the tuning profile that you want to apply in /usr/share/foreman-installer/config/foreman.hiera/tuning/sizes/. Compare the configuration entries against the entries in your /etc/foreman-installer/custom-hiera.yaml file and remove any duplicated configuration settings in your /etc/foreman-installer/custom-hiera.yaml file.
  3. Enter the satellite-installer command with the --tuning option for the profile that you want to apply. For example, to apply the medium tuning profile settings, enter the following command:

    # satellite-installer --tuning medium
    Copy to Clipboard Toggle word wrap

Chapter 2. Installing Satellite Server

When the intended host for Satellite Server is in a disconnected environment, you can install Satellite Server by using an external computer to download an ISO image of the packages, and copying the packages to the system you want to install Satellite Server on. This method is not recommended for any other situation as ISO images might not contain the latest updates, bug fixes, and functionality.

Use the following procedures to install Satellite Server, perform the initial configuration, and import subscription manifests.

Before you continue, consider which manifests are relevant for your environment. For more information on manifests, see Managing Red Hat Subscriptions in Managing content.

Note

You cannot register Satellite Server to itself.

2.1. Downloading the binary DVD images

Use this procedure to download the ISO images for Red Hat Enterprise Linux and Red Hat Satellite.

Procedure

  1. Go to Red Hat Customer Portal and log in.
  2. Click DOWNLOADS.
  3. Select Red Hat Enterprise Linux.
  4. Click All Red Hat Enterprise Linux Downloads.
  5. Ensure that you have the correct product and version for your environment.

    • Product Variant is set to Red Hat Enterprise Linux for x86_64.
    • Version is set to the latest minor version of the product you plan to use as the base operating system.
    • Architecture is set to the 64 bit version.
  6. On the Product Software tab, download the Binary DVD image for the latest Red Hat Enterprise Linux for x86_64 version.
  7. Click DOWNLOADS and select Red Hat Satellite.
  8. Ensure that you have the correct product and version for your environment.

    • Product Variant is set to Red Hat Satellite.
    • Version is set to the latest minor version of the product you plan to use.
  9. On the Product Software tab, download the Binary DVD image for the latest Red Hat Satellite version.
  10. Copy the ISO files to /var/tmp on the Satellite base operating system or other accessible storage device.

    # scp localfile username@hostname:remotefile
    Copy to Clipboard Toggle word wrap

Use this procedure to configure offline repositories for Red Hat Enterprise Linux 9 and Red Hat Satellite ISO images.

Procedure

  1. Create a directory to serve as the mount point for the ISO file corresponding to the version of the base operating system.

    # mkdir /media/rhel
    Copy to Clipboard Toggle word wrap
  2. Mount the ISO image for Red Hat Enterprise Linux to the mount point.

    # mount -o loop rhel-DVD.iso /media/rhel
    Copy to Clipboard Toggle word wrap
  3. To copy the ISO file’s repository data file and change permissions, enter:

    # cp /media/rhel/media.repo /etc/yum.repos.d/rhel.repo
    # chmod u+w /etc/yum.repos.d/rhel.repo
    Copy to Clipboard Toggle word wrap
  4. Edit the repository data file and add the baseurl directive.

    [RHEL-BaseOS]
    name=Red Hat Enterprise Linux BaseOS
    mediaid=None
    metadata_expire=-1
    gpgcheck=0
    cost=500
    baseurl=file:///media/rhel/BaseOS/
    
    [RHEL-AppStream]
    name=Red Hat Enterprise Linux Appstream
    mediaid=None
    metadata_expire=-1
    gpgcheck=0
    cost=500
    baseurl=file:///media/rhel/AppStream/
    Copy to Clipboard Toggle word wrap
  5. Verify that the repository has been configured.

    # yum repolist
    Copy to Clipboard Toggle word wrap
  6. Create a directory to serve as the mount point for the ISO file of Satellite Server.

    # mkdir /media/sat6
    Copy to Clipboard Toggle word wrap
  7. Mount the ISO image for Satellite Server to the mount point.

    # mount -o loop sat6-DVD.iso /media/sat6
    Copy to Clipboard Toggle word wrap

By enabling fapolicyd on your Satellite Server, you can provide an additional layer of security by monitoring and controlling access to files and directories. The fapolicyd daemon uses the RPM database as a repository of trusted binaries and scripts.

You can turn on or off the fapolicyd on your Satellite Server or Capsule Server at any point.

2.3.1. Installing fapolicyd on Satellite Server

You can install fapolicyd along with Satellite Server or can be installed on an existing Satellite Server. If you are installing fapolicyd along with the new Satellite Server, the installation process will detect the fapolicyd in your Red Hat Enterprise Linux host and deploy the Satellite Server rules automatically.

Prerequisites

  • Ensure your host has access to the BaseOS repositories of Red Hat Enterprise Linux.

Procedure

  1. For a new installation, install fapolicyd:

    # dnf install fapolicyd
    Copy to Clipboard Toggle word wrap
  2. For an existing installation, install fapolicyd using satellite-maintain packages install:

    # satellite-maintain packages install fapolicyd
    Copy to Clipboard Toggle word wrap
  3. Start the fapolicyd service:

    # systemctl enable --now fapolicyd
    Copy to Clipboard Toggle word wrap

Verification

  • Verify that the fapolicyd service is running correctly:

    # systemctl status fapolicyd
    Copy to Clipboard Toggle word wrap

New Satellite Server or Capsule Server installations

In case of new Satellite Server or Capsule Server installation, follow the standard installation procedures after installing and enabling fapolicyd on your Red Hat Enterprise Linux host.

Additional resources

For more information on fapolicyd, see Blocking and allowing applications using fapolicyd in Red Hat Enterprise Linux 9 Security hardening.

Use this procedure to install the Satellite packages from the offline repositories.

Procedure

  1. Ensure the ISO images for Red Hat Enterprise Linux Server and Red Hat Satellite are mounted:

    # findmnt -t iso9660
    Copy to Clipboard Toggle word wrap
  2. Import the Red Hat GPG keys:

    # rpm --import /etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release
    Copy to Clipboard Toggle word wrap
  3. Ensure the base operating system is up to date with the Binary DVD image:

    # dnf upgrade
    Copy to Clipboard Toggle word wrap
  4. Change to the directory where the Satellite ISO is mounted:

    # cd /media/sat6/
    Copy to Clipboard Toggle word wrap
  5. Run the installation script in the mounted directory:

    # ./install_packages
    Copy to Clipboard Toggle word wrap

    If you have successfully installed the Satellite packages, the following message is displayed: Install is complete. Please run satellite-installer --scenario satellite.

2.5. Resolving package dependency errors

If there are package dependency errors during installation of Satellite Server packages, you can resolve the errors by downloading and installing packages from Red Hat Customer Portal. For more information about resolving dependency errors, see the KCS solution How can I use the yum output to solve yum dependency errors?.

If you have successfully installed the Satellite packages, skip this procedure.

Procedure

  1. Go to the Red Hat Customer Portal and log in.
  2. Click DOWNLOADS.
  3. Click the product that contains the package that you want to download.
  4. Ensure that you have the correct Product Variant, Version, and Architecture for your environment.
  5. Click the Packages tab.
  6. In the Search field, enter the name of the package.
  7. Click the package.
  8. From the Version list, select the version of the package.
  9. At the bottom of the page, click Download Now.
  10. Copy the package to the Satellite base operating system.
  11. On Satellite Server, change to the directory where the package is located:

    # cd /path-to-package/
    Copy to Clipboard Toggle word wrap
  12. Install the package locally:

    # dnf install package_name
    Copy to Clipboard Toggle word wrap
  13. Change to the directory where the Satellite ISO is mounted:

    # cd /media/sat6/
    Copy to Clipboard Toggle word wrap
  14. Verify that you have resolved the package dependency errors by installing Satellite Server packages. If there are further package dependency errors, repeat this procedure.

    # ./install_packages
    Copy to Clipboard Toggle word wrap

    If you have successfully installed the Satellite packages, the following message is displayed: Install is complete. Please run satellite-installer --scenario satellite.

2.6. Configuring Satellite Server

Install Satellite Server using the satellite-installer installation script. Choose from one of the following methods:

  • Section 2.6.1, “Configuring Satellite installation”. This method is performed by running the installation script with one or more command options. The command options override the corresponding default initial configuration options and are recorded in the Satellite answer file. You can run the script as often as needed to configure any necessary options.

2.6.1. Configuring Satellite installation

This initial configuration procedure creates an organization, location, user name, and password. After the initial configuration, you can create additional organizations and locations if required. The initial configuration also installs PostgreSQL databases on the same server.

The installation process can take tens of minutes to complete. If you are connecting remotely to the system, use a utility such as tmux that allows suspending and reattaching a communication session so that you can check the installation progress in case you become disconnected from the remote system. If you lose connection to the shell where the installation command is running, see the log at /var/log/foreman-installer/satellite.log to determine if the process completed successfully.

Considerations

  • Use the satellite-installer --scenario satellite --help command to display the most commonly used options and any default values.
  • Use the satellite-installer --scenario satellite --full-help command to display advanced options.
  • Specify a meaningful value for the option: --foreman-initial-organization. This can be your company name. An internal label that matches the value is also created and cannot be changed afterwards. If you do not specify a value, an organization called Default Organization with the label Default_Organization is created. You can rename the organization name but not the label.
  • By default, all configuration files configured by the installer are managed. When satellite-installer runs, it overwrites any manual changes to the managed files with the intended values. This means that running the installer on a broken system should restore it to working order, regardless of changes made. For more information on how to apply custom configuration on other services, see Applying Custom Configuration to Satellite.

Procedure

  1. Enter the following command with any additional options that you want to use:

    # satellite-installer --scenario satellite \
    --foreman-initial-organization "My_Organization" \
    --foreman-initial-location "My_Location" \
    --foreman-initial-admin-username admin_user_name \
    --foreman-initial-admin-password admin_password
    Copy to Clipboard Toggle word wrap

    The script displays its progress and writes logs to /var/log/foreman-installer/satellite.log.

  2. Unmount the ISO images:

    # umount /media/sat6
    # umount /media/rhel
    Copy to Clipboard Toggle word wrap

2.7. Disabling subscription connection

Disable subscription connection on disconnected Satellite Server to avoid connecting to the Red Hat Portal. This will also prevent you from refreshing the manifest and updating upstream entitlements.

Procedure

  1. In the Satellite web UI, navigate to Administer > Settings.
  2. Click the Content tab.
  3. Set the Subscription Connection Enabled value to No.

CLI procedure

  • Enter the following command on Satellite Server:

    $ hammer settings set --name subscription_connection_enabled --value false
    Copy to Clipboard Toggle word wrap

Use the following procedure to import a Red Hat subscription manifest into Satellite Server.

Note

Simple Content Access (SCA) is set on the organization, not the manifest. Importing a manifest does not change your organization’s Simple Content Access status.

Simple Content Access simplifies the subscription experience for administrators. For more information, see the Subscription Management Administration Guide for Red Hat Enterprise Linux on the Red Hat Customer Portal.

Prerequisites

Procedure

  1. In the Satellite web UI, ensure the context is set to the organization you want to use.
  2. In the Satellite web UI, navigate to Content > Subscriptions and click Manage Manifest.
  3. In the Manage Manifest window, click Choose File.
  4. Navigate to the location that contains the Red Hat subscription manifest file, then click Open.

CLI procedure

  1. Copy the Red Hat subscription manifest file from your local machine to Satellite Server:

    $ scp ~/manifest_file.zip root@satellite.example.com:~/.
    Copy to Clipboard Toggle word wrap
  2. Log in to Satellite Server as the root user and import the Red Hat subscription manifest file:

    $ hammer subscription upload \
    --file ~/manifest_file.zip \
    --organization "My_Organization"
    Copy to Clipboard Toggle word wrap

You can now enable repositories and import Red Hat content. For more information, see Importing Content in Managing content.

Important

Insights advisor in Satellite is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.

For more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.

Insights advisor in Satellite analyzes system health and configuration by applying predefined rules to a small set of local data, such as installed packages, running services, and configuration settings. When you install Insights advisor in Satellite locally, you can generate Insights recommendations without sending system data to Red Hat services.

Important

With Insights advisor in Satellite enabled, you cannot use the hosted Insights services for hosts registered to your Satellite. Enabling Insights advisor in Satellite prevents you from using any Red Hat Hybrid Cloud Console services on the registered hosts.

You can use the Satellite installation ISO image to access the required container content.

Prerequisites

  • Ensure that skopeo is installed. For more information, see Getting container tools in Red Hat Enterprise Linux 9 Building, running, and managing containers.

Procedure

  1. Download and mount the Satellite ISO image: For more information, see Section 2.4, “Installing the Satellite packages from the offline repositories”.
  2. Set up the local repositories for disconnected environments. For more information, see Section 2.4, “Installing the Satellite packages from the offline repositories”.
  3. Set up containers on your Satellite Server:

    # /media/sat6/containers/setup_containers
    Copy to Clipboard Toggle word wrap
  4. Enable the plugin:

    # satellite-installer --foreman-plugin-rh-cloud-enable-iop-advisor-engine true
    Copy to Clipboard Toggle word wrap

You can transfer the container image from a connected system to a disconnected Satellite Server.

Prerequisites

  • The container image is downloaded on a connected system.
  • Ensure that skopeo is installed. For more information, see Getting container tools in Red Hat Enterprise Linux 9 Building, running, and managing containers.
  • The disconnected Satellite Server is prepared to receive the image.

Procedure

  1. On the connected system, export the container image:

    # skopeo copy containers-storage:registry.redhat.io/satellite/iop-advisor-engine-rhel9:6.17 \
    oci-archive:/tmp/iop-advisor-engine.tar
    Copy to Clipboard Toggle word wrap
  2. Transfer the iop-advisor-engine.tar file to the disconnected Satellite Server.
  3. On the disconnected Satellite Server, import the container image:

    # skopeo copy oci-archive:/tmp/iop-advisor-engine.tar \
    containers-storage:registry.redhat.io/satellite/iop-advisor-engine-rhel9:6.17
    Copy to Clipboard Toggle word wrap
  4. Enable the plugin:

    # satellite-installer --foreman-plugin-rh-cloud-enable-iop-advisor-engine true
    Copy to Clipboard Toggle word wrap

If you have an internal Content Delivery Network (CDN) or serve content on an accessible web server, you can configure your Satellite Server to consume Red Hat repositories from this CDN server instead of the Red Hat CDN. A CDN server can be any web server that mirrors repositories in the same directory structure as the Red Hat CDN.

You can configure the source of content for each organization. Satellite recognizes automatically which Red Hat repositories from the subscription manifest in your organization are available on your CDN server.

Prerequisites

  • You have a CDN server that provides Red Hat content and is accessible by Satellite Server.
  • If your CDN server uses HTTPS, ensure you have uploaded the SSL certificate into Satellite. For more information, see Importing Custom SSL Certificates in Managing content.
  • You have uploaded a manifest to your organization.

Procedure

  1. In the Satellite web UI, navigate to Content > Subscriptions.
  2. Click Manage Manifest.
  3. Select the CDN Configuration tab.
  4. Select the Custom CDN tab.
  5. In the URL field, enter the URL of your CDN server from which you want Satellite Server to consume Red Hat repositories.
  6. Optional: In the SSL CA Content Credential, select the SSL certificate of the CDN server.
  7. Click Update.
  8. You can now enable Red Hat repositories consumed from your internal CDN server.

CLI procedure

  1. Connect to your Satellite Server using SSH.
  2. Set CDN configuration to your custom CDN server:

    $ hammer organization configure-cdn --name="My_Organization" \
    --type=custom_cdn \
    --url https://my-cdn.example.com \
    --ssl-ca-credential-id "My_CDN_CA_Cert_ID"
    Copy to Clipboard Toggle word wrap

Additional resources

Configure Inter-Satellite Synchronization on your disconnected Satellite Server to provide content in your disconnected network.

If you deployed your downstream Satellite Server as air gapped, configure your Satellite Server as such to avoid attempts to consume content from a network.

Procedure

  1. In the Satellite web UI, navigate to Content > Subscriptions.
  2. Click Manage Manifest.
  3. Switch to the CDN Configuration tab.
  4. Select the Export Sync tab.
  5. Click Update.

CLI procedure

  1. Log in to your Satellite Server by using SSH.
  2. Set CDN configuration to sync by using exports:

    $ hammer organization configure-cdn --name="My_Organization" --type=export_sync
    Copy to Clipboard Toggle word wrap

Additional resources

Configure a downstream Satellite Server to synchronize repositories from a connected upstream Satellite Server over HTTPS.

Prerequisites

  • A network connection exists between the upstream Satellite Server and the downstream Satellite Server.
  • You imported the same subscription manifest on both the upstream and downstream Satellite Server. For more information, see Section 2.8, “Importing a Red Hat subscription manifest into Satellite Server”.
  • On the upstream Satellite Server, you enabled the required repositories for the organization. For more information, see Enabling Red Hat Repositories in Managing content.
  • The upstream user is an admin or has the following permissions:

    • view_organizations
    • view_products
    • export_content
    • view_lifecycle_environments
    • view_content_views
  • On the downstream Satellite Server, you have imported the SSL certificate of the upstream Satellite Server using the contents of http://upstream-satellite.example.com/pub/katello-server-ca.crt. For more information, see Importing SSL Certificates in Managing content.
  • The downstream user is an admin or has the permissions to create product repositories and organizations.

Procedure

  1. Navigate to Content > Subscriptions.
  2. Click Manage Manifest.
  3. Navigate to the CDN Configuration tab.
  4. Select the Network Sync tab.
  5. In the URL field, enter the address of the upstream Satellite Server.
  6. In the Username, enter your username for upstream login.
  7. In the Password, enter your password or personal access token for upstream login.
  8. In the Organization label field, enter the label of the upstream organization.
  9. Optional: In the Lifecycle Environment Label field, enter the label of the upstream lifecycle environment. Default is Library.
  10. Optional: In the Content view label field, enter the label of the upstream content view. Default is Default_Organization_View.
  11. From the SSL CA Content Credential menu, select a CA certificate used by the upstream Satellite Server.
  12. Click Update.
  13. In the Satellite web UI, navigate to Content > Products.
  14. Select the product that contains the repositories that you want to synchronize.
  15. From the Select Action menu, select Sync Now to synchronize all repositories within the product.

    You can also create a synchronization plan to ensure updates on a regular basis. For more information, see Creating a Synchronization Plan in Managing content.

CLI procedure

  1. Connect to your downstream Satellite Server using SSH.
  2. View information about the upstream CA certificate:

    $ hammer content-credential show \
    --name="My_Upstream_CA_Cert" \
    --organization="My_Downstream_Organization"
    Copy to Clipboard Toggle word wrap

    Note the ID of the CA certificate for the next step.

  3. Set CDN configuration to an upstream Satellite Server:

    $ hammer organization configure-cdn --name="My_Downstream_Organization" \
    --type=network_sync \
    --url https://upstream-satellite.example.com \
    --username upstream_username --password upstream_password \
    --ssl-ca-credential-id "My_Upstream_CA_Cert_ID" \ --upstream-organization-label="_My_Upstream_Organization" \
    [--upstream-lifecycle-environment-label="My_Lifecycle_Environment"] \
    [--upstream-content-view-label="My_Content_View"]
    Copy to Clipboard Toggle word wrap

    The default lifecycle environment label is Library. The default content view label is Default_Organization_View.

By default, remote execution uses push-based SSH as the transport mechanism for the Script provider. If your infrastructure prohibits outgoing connections from Satellite Server to hosts, you can use remote execution with pull-based transport instead, because the host initiates the connection to Satellite Server. The use of pull-based transport is not limited to those infrastructures.

The pull-based transport comprises pull-mqtt mode on Capsules in combination with a pull client running on hosts.

Note

The pull-mqtt mode works only with the Script provider. Ansible and other providers will continue to use their default transport settings.

Procedure

  1. Enable the pull-based transport on your Satellite Server:

    # satellite-installer --foreman-proxy-plugin-remote-execution-script-mode pull-mqtt
    Copy to Clipboard Toggle word wrap
  2. Configure the firewall to allow the MQTT service on port 1883:

    # firewall-cmd --add-service=mqtt
    Copy to Clipboard Toggle word wrap
  3. Make the changes persistent:

    # firewall-cmd --runtime-to-permanent
    Copy to Clipboard Toggle word wrap
  4. In pull-mqtt mode, hosts subscribe for job notifications to either your Satellite Server or any Capsule Server through which they are registered. Ensure that Satellite Server sends remote execution jobs to that same Satellite Server or Capsule Server:

    1. In the Satellite web UI, navigate to Administer > Settings.
    2. On the Content tab, set the value of Prefer registered through Capsule for remote execution to Yes.

Next steps

3.5. Enabling power management on hosts

To perform power management tasks on hosts using the intelligent platform management interface (IPMI) or a similar protocol, you must enable the baseboard management controller (BMC) module on Satellite Server.

Prerequisites

Procedure

  • To enable BMC, enter the following command:

    # satellite-installer \
    --foreman-proxy-bmc "true" \
    --foreman-proxy-bmc-default-provider "freeipmi"
    Copy to Clipboard Toggle word wrap

To send email messages from Satellite Server, you can use either an SMTP server, or the sendmail command.

Prerequisites

  • Some SMTP servers with anti-spam protection or grey-listing features are known to cause problems. To setup outgoing email with such a service either install and configure a vanilla SMTP service on Satellite Server for relay or use the sendmail command instead.

Procedure

  1. In the Satellite web UI, navigate to Administer > Settings.
  2. Click the Email tab and set the configuration options to match your preferred delivery method. The changes have an immediate effect.

    1. The following example shows the configuration options for using an SMTP server:

      Expand
      Table 3.1. Using an SMTP server as a delivery method
      NameExample valueAdditional information

      Delivery method

      SMTP

       

      SMTP address

      smtp.example.com

       

      SMTP authentication

      login

       

      SMTP HELO/EHLO domain

      example.com

       

      SMTP password

      password

      Use the login credentials for the SMTP server.

      SMTP port

      25

       

      SMTP username

      user@example.com

      Use the login credentials for the SMTP server.

    2. The following example uses gmail.com as an SMTP server:

      Expand
      Table 3.2. Using gmail.com as an SMTP server
      NameExample valueAdditional information

      Delivery method

      SMTP

       

      SMTP address

      smtp.gmail.com

       

      SMTP authentication

      plain

       

      SMTP HELO/EHLO domain

      smtp.gmail.com

       

      SMTP enable StartTLS auto

      Yes

       

      SMTP password

      app password

      Use the Google app password. For more information, see Sign in with app passwords in Google Help Center.

      SMTP port

      587

       

      SMTP username

      user@gmail.com

      Use the Google account name.

    3. The following example uses the sendmail command as a delivery method:

      Expand
      Table 3.3. Using sendmail as a delivery method
      NameExample valueAdditional information

      Delivery method

      Sendmail

       

      Sendmail location

      /usr/sbin/sendmail

      For security reasons, both Sendmail location and Sendmail argument settings are read-only and can be only set in /etc/foreman/settings.yaml. Both settings currently cannot be set via satellite-installer. For more information see the sendmail 1 man page.

      Sendmail arguments

      -i

  3. If you decide to send email using an SMTP server which uses TLS authentication, also perform one of the following steps:

    • Mark the CA certificate of the SMTP server as trusted. To do so, execute the following commands on Satellite Server:

      # cp mailca.crt /etc/pki/ca-trust/source/anchors/
      # update-ca-trust enable
      # update-ca-trust
      Copy to Clipboard Toggle word wrap

      Where mailca.crt is the CA certificate of the SMTP server.

    • Alternatively, in the Satellite web UI, set the SMTP enable StartTLS auto option to No.
  4. Click Test email to send a test message to the user’s email address to confirm the configuration is working. If a message fails to send, the Satellite web UI displays an error. See the log at /var/log/foreman/production.log for further details.

Additional resources

As well as providing access to Satellite Server, hosts provisioned with Satellite can also be integrated with Identity Management realms. Red Hat Satellite has a realm feature that automatically manages the lifecycle of any system registered to a realm or domain provider.

Use this section to configure Satellite Server or Capsule Server for Identity Management realm support, then add hosts to the Identity Management realm group.

Prerequisites

  • Satellite Server that is registered to the Content Delivery Network or your Capsule Server that is registered to Satellite Server.
  • A deployed realm or domain provider such as Identity Management.

To install and configure Identity Management packages on Satellite Server or Capsule Server:

To use Identity Management for provisioned hosts, complete the following steps to install and configure Identity Management packages on Satellite Server or Capsule Server:

  1. Install the ipa-client package on Satellite Server or Capsule Server:

    # satellite-maintain packages install ipa-client
    Copy to Clipboard Toggle word wrap
  2. Configure the server as a Identity Management client:

    # ipa-client-install
    Copy to Clipboard Toggle word wrap
  3. Create a realm proxy user, realm-capsule, and the relevant roles in Identity Management:

    # foreman-prepare-realm admin realm-capsule
    Copy to Clipboard Toggle word wrap

    Note the principal name that returns and your Identity Management server configuration details because you require them for the following procedure.

To configure Satellite Server or Capsule Server for Identity Management realm support:

Complete the following procedure on Satellite and every Capsule that you want to use:

  1. Copy the /root/freeipa.keytab file to any Capsule Server that you want to include in the same principal and realm:

    # scp /root/freeipa.keytab root@capsule.example.com:/etc/foreman-proxy/freeipa.keytab
    Copy to Clipboard Toggle word wrap
  2. On your Satellite Server, move the /root/freeipa.keytab file to the /etc/foreman-proxy directory:

    # mv /root/freeipa.keytab /etc/foreman-proxy
    Copy to Clipboard Toggle word wrap
  3. On your Satellite Server and Capsule Servers, set ownership to the foreman-proxy user and group:

    # chown foreman-proxy:foreman-proxy /etc/foreman-proxy/freeipa.keytab
    Copy to Clipboard Toggle word wrap
  4. Enter the following command on all Capsules that you want to include in the realm. If you use the integrated Capsule on Satellite, enter this command on Satellite Server:

    # satellite-installer --foreman-proxy-realm true \
    --foreman-proxy-realm-keytab /etc/foreman-proxy/freeipa.keytab \
    --foreman-proxy-realm-principal realm-capsule@EXAMPLE.COM \
    --foreman-proxy-realm-provider freeipa
    Copy to Clipboard Toggle word wrap

    You can also use these options when you first configure the Satellite Server.

  5. Ensure that the most updated versions of the ca-certificates package is installed and trust the Identity Management Certificate Authority:

    # cp /etc/ipa/ca.crt /etc/pki/ca-trust/source/anchors/ipa.crt
    # update-ca-trust enable
    # update-ca-trust
    Copy to Clipboard Toggle word wrap
  6. Optional: If you configure Identity Management on an existing Satellite Server or Capsule Server, complete the following steps to ensure that the configuration changes take effect:

    1. Restart the foreman-proxy service:

      # systemctl restart foreman-proxy
      Copy to Clipboard Toggle word wrap
    2. In the Satellite web UI, navigate to Infrastructure > Capsules.
    3. Locate the Capsule you have configured for Identity Management and from the list in the Actions column, select Refresh.

To create a realm for the Identity Management-enabled Capsule

After you configure your Capsule with Identity Management, you must create a realm and add the Identity Management-configured Capsule to the realm.

Procedure

  1. In the Satellite web UI, navigate to Infrastructure > Realms and click Create Realm.
  2. In the Name field, enter a name for the realm.
  3. From the Realm Type list, select the type of realm.
  4. From the Realm Capsule list, select Capsule Server where you have configured Identity Management.
  5. Click the Locations tab and from the Locations list, select the location where you want to add the new realm.
  6. Click the Organizations tab and from the Organizations list, select the organization where you want to add the new realm.
  7. Click Submit.

Updating host groups with realm information

You must update any host groups that you want to use with the new realm information.

  1. In the Satellite web UI, navigate to Configure > Host Groups, select the host group that you want to update, and click the Network tab.
  2. From the Realm list, select the realm you create as part of this procedure, and then click Submit.

Adding hosts to a Identity Management host group

Identity Management supports the ability to set up automatic membership rules based on a system’s attributes. Red Hat Satellite’s realm feature provides administrators with the ability to map the Red Hat Satellite host groups to the Identity Management parameter userclass which allow administrators to configure automembership.

When nested host groups are used, they are sent to the Identity Management server as they are displayed in the Red Hat Satellite User Interface. For example, "Parent/Child/Child".

Satellite Server or Capsule Server sends updates to the Identity Management server, however automembership rules are only applied at initial registration.

To add hosts to a Identity Management host group:

  1. On the Identity Management server, create a host group:

    # ipa hostgroup-add hostgroup_name --desc=hostgroup_description
    Copy to Clipboard Toggle word wrap
  2. Create an automembership rule:

    # ipa automember-add --type=hostgroup hostgroup_name automember_rule
    Copy to Clipboard Toggle word wrap

    Where you can use the following options:

    • automember-add flags the group as an automember group.
    • --type=hostgroup identifies that the target group is a host group, not a user group.
    • automember_rule adds the name you want to identify the automember rule by.
  3. Define an automembership condition based on the userclass attribute:

    # ipa automember-add-condition --key=userclass --type=hostgroup --inclusive-regex=^webserver hostgroup_name
    ----------------------------------
    Added condition(s) to "hostgroup_name"
    ----------------------------------
    Automember Rule: automember_rule
    Inclusive Regex: userclass=^webserver
    ----------------------------
    Number of conditions added 1
    ----------------------------
    Copy to Clipboard Toggle word wrap

    Where you can use the following options:

    • automember-add-condition adds regular expression conditions to identify group members.
    • --key=userclass specifies the key attribute as userclass.
    • --type=hostgroup identifies that the target group is a host group, not a user group.
    • --inclusive-regex= ^webserver identifies matching values with a regular expression pattern.
    • hostgroup_name – identifies the target host group’s name.

When a system is added to Satellite Server’s hostgroup_name host group, it is added automatically to the Identity Management server’s "hostgroup_name" host group. Identity Management host groups allow for Host-Based Access Controls (HBAC), sudo policies and other Identity Management functions.

By default, Red Hat Satellite uses a self-signed SSL certificate to enable encrypted communications between Satellite Server, Capsule Servers, and all hosts. If you cannot use a Satellite self-signed certificate, you can configure Satellite Server to use an SSL certificate signed by an external certificate authority (CA).

When you configure Red Hat Satellite with custom SSL certificates, you must fulfill the following requirements:

  • You must use the privacy-enhanced mail (PEM) encoding for the SSL certificates.
  • You must not use the same SSL certificate for both Satellite Server and Capsule Server.
  • The same CA must sign certificates for Satellite Server and Capsule Server.
  • An SSL certificate must not also be a CA certificate.
  • An SSL certificate must include a subject alt name (SAN) entry that matches the common name (CN).
  • An SSL certificate must be allowed for Key Encipherment using a Key Usage extension.
  • An SSL certificate must not have a shortname as the CN.
  • You must not set a passphrase for the private key.

To configure your Satellite Server with a custom certificate, complete the following procedures:

Use this procedure to create a custom SSL certificate for Satellite Server. If you already have a custom SSL certificate for Satellite Server, skip this procedure.

Procedure

  1. To store all the source certificate files, create a directory that is accessible only to the root user:

    # mkdir /root/satellite_cert
    Copy to Clipboard Toggle word wrap
  2. Create a private key with which to sign the certificate signing request (CSR).

    Note that the private key must be unencrypted. If you use a password-protected private key, remove the private key password.

    If you already have a private key for this Satellite Server, skip this step.

    # openssl genrsa -out /root/satellite_cert/satellite_cert_key.pem 4096
    Copy to Clipboard Toggle word wrap
  3. Create the /root/satellite_cert/openssl.cnf configuration file for the CSR and include the following content:

    [ req ]
    req_extensions = v3_req
    distinguished_name = req_distinguished_name
    prompt = no
    
    [ req_distinguished_name ]
    commonName = satellite.example.com
    
    [ v3_req ]
    basicConstraints = CA:FALSE
    keyUsage = digitalSignature, keyEncipherment
    extendedKeyUsage = serverAuth, clientAuth
    subjectAltName = @alt_names
    
    [ alt_names ]
    DNS.1 = satellite.example.com
    Copy to Clipboard Toggle word wrap

    For more information about the [ v3_req ] parameters and their purpose, see RFC 5280: Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile.

  4. Optional: If you want to add Distinguished Name (DN) details to the CSR, add the following information to the [ req_distinguished_name ] section:

    [req_distinguished_name]
    CN = satellite.example.com
    countryName = My_Country_Name 
    1
    
    stateOrProvinceName = My_State_Or_Province_Name 
    2
    
    localityName = My_Locality_Name 
    3
    
    organizationName = My_Organization_Or_Company_Name
    organizationalUnitName = My_Organizational_Unit_Name 
    4
    Copy to Clipboard Toggle word wrap
    1
    Two letter code
    2
    Full name
    3
    Full name (example: New York)
    4
    Division responsible for the certificate (example: IT department)
  5. Generate CSR:

    # openssl req -new \
    -key /root/satellite_cert/satellite_cert_key.pem \ 
    1
    
    -config /root/satellite_cert/openssl.cnf \ 
    2
    
    -out /root/satellite_cert/satellite_cert_csr.pem 
    3
    Copy to Clipboard Toggle word wrap
    1
    Path to the private key
    2
    Path to the configuration file
    3
    Path to the CSR to generate
  6. Send the certificate signing request to the certificate authority (CA). The same CA must sign certificates for Satellite Server and Capsule Server.

    When you submit the request, specify the lifespan of the certificate. The method for sending the certificate request varies, so consult the CA for the preferred method. In response to the request, you can expect to receive a CA bundle and a signed certificate, in separate files.

Use this procedure to configure your Satellite Server to use a custom SSL certificate signed by a Certificate Authority.

Important

Do not store the SSL certificates or .tar bundles in /tmp or /var/tmp directory. The operating system removes files from these directories periodically. As a result, satellite-installer fails to execute while enabling features or upgrading Satellite Server.

Procedure

  • Update certificates on your Satellite Server:

    # satellite-installer \
    --certs-server-cert "/root/satellite_cert/satellite_cert.pem" \ 
    1
    
    --certs-server-key "/root/satellite_cert/satellite_cert_key.pem" \ 
    2
    
    --certs-server-ca-cert "/root/satellite_cert/ca_cert_bundle.pem" \ 
    3
    
    --certs-update-server --certs-update-server-ca
    Copy to Clipboard Toggle word wrap
    1
    Path to Satellite Server certificate file that is signed by a Certificate Authority.
    2
    Path to the private key that was used to sign Satellite Server certificate.
    3
    Path to the Certificate Authority bundle.

Verification

  1. On a computer with network access to Satellite Server, navigate to the following URL: https://satellite.example.com.
  2. In your browser, view the certificate details to verify the deployed certificate.

3.8.3. Deploying a custom SSL certificate to hosts

After you configure Satellite to use a custom SSL certificate, you must deploy the certificate to hosts registered to Satellite.

Procedure

  • Update the SSL certificate on each host:

    # dnf install http://satellite.example.com/pub/katello-ca-consumer-latest.noarch.rpm
    Copy to Clipboard Toggle word wrap

3.9. Using external databases with Satellite

The Satellite installation process includes installing a PostgreSQL database on the same host as Satellite Server. In certain Satellite deployments, using external databases instead of the default local databases can help with the server load.

Running the satellite-installer command, used to install a Satellite Server, also installs PostgreSQL databases on the server. However, you can configure your Satellite Server to use external databases instead. Moving to external databases distributes the workload and can reduce overall Satellite memory usage.

Note

Red Hat does not provide support or tools for external database maintenance. If you deploy Satellite with external databases, you will need to support and maintain the external databases yourself.

Consider using external databases if you plan to use your Satellite deployment for the following scenarios:

  • Frequent remote execution tasks. This requires a high volume of records in PostgreSQL and generates heavy database workloads.
  • High disk I/O workloads from frequent repository synchronization or content view publishing. This requires Satellite to create a record in PostgreSQL for each job.
  • High volume of hosts.
  • High volume of synchronized content.

Foreman, Katello, and Candlepin use the PostgreSQL database. If you want to use PostgreSQL as an external database, the following information can help you decide if this option is right for your Satellite configuration. Satellite supports PostgreSQL version 13.

Advantages of external PostgreSQL

  • Increase in free memory and free CPU on Satellite
  • Flexibility to set shared_buffers on the PostgreSQL database to a high number without the risk of interfering with other services on Satellite
  • Flexibility to tune the PostgreSQL server’s system without adversely affecting Satellite operations

Disadvantages of external PostgreSQL

  • Increase in deployment complexity that can make troubleshooting more difficult
  • The external PostgreSQL server is an additional system to patch and maintain
  • If either Satellite or the PostgreSQL database server suffers a hardware or storage failure, Satellite is not operational
  • If there is latency between the Satellite server and database server, performance can suffer

If you suspect that the PostgreSQL database on your Satellite is causing performance problems, use the information in Satellite 6: How to enable postgres query logging to detect slow running queries to determine if you have slow queries. Queries that take longer than one second are typically caused by performance issues with large installations, and moving to an external database might not help. If you have slow queries, contact Red Hat Support.

3.9.3. Installing PostgreSQL

You can install only the same version of PostgreSQL that is installed with the satellite-installer tool during an internal database installation. Satellite supports PostgreSQL version 13.

Prerequisites

  • The prepared host must meet Satellite Storage requirements.
  • The prepared host has base operating system repositories enabled.

Procedure

  1. On your new database server, install PostgreSQL:

    # dnf install postgresql-server postgresql-contrib
    Copy to Clipboard Toggle word wrap
  2. Initialize the PostgreSQL database:

    # postgresql-setup --initdb
    Copy to Clipboard Toggle word wrap
  3. Edit the /var/lib/pgsql/data/postgresql.conf file:

    # vi /var/lib/pgsql/data/postgresql.conf
    Copy to Clipboard Toggle word wrap

    Note that the default configuration of external PostgreSQL needs to be adjusted to work with Satellite. The base recommended external database configuration adjustments are as follows:

    • checkpoint_completion_target: 0.9
    • max_connections: 500
    • shared_buffers: 512MB
    • work_mem: 4MB
  4. Remove the # and edit to listen to inbound connections:

    listen_addresses = '*'
    Copy to Clipboard Toggle word wrap
  5. Add the following line to the end of the file to use SCRAM for authentication:

    password_encryption=scram-sha-256
    Copy to Clipboard Toggle word wrap
  6. Edit the /var/lib/pgsql/data/pg_hba.conf file:

    # vi /var/lib/pgsql/data/pg_hba.conf
    Copy to Clipboard Toggle word wrap
  7. Add the following line to the file:

      host  all   all   Satellite_ip/32   scram-sha-256
    Copy to Clipboard Toggle word wrap
  8. Start and enable the PostgreSQL service:

    # systemctl enable --now postgresql
    Copy to Clipboard Toggle word wrap
  9. Open the postgresql port:

    # firewall-cmd --add-service=postgresql
    Copy to Clipboard Toggle word wrap
  10. Make the changes persistent:

    # firewall-cmd --runtime-to-permanent
    Copy to Clipboard Toggle word wrap
  11. Switch to the postgres user and start the PostgreSQL client:

    $ su - postgres -c psql
    Copy to Clipboard Toggle word wrap
  12. Create three databases and dedicated roles: one for Foreman, one for Candlepin, and one for Pulp:

    CREATE USER "foreman" WITH PASSWORD 'Foreman_Password';
    CREATE USER "candlepin" WITH PASSWORD 'Candlepin_Password';
    CREATE USER "pulp" WITH PASSWORD 'Pulpcore_Password';
    CREATE DATABASE foreman OWNER foreman;
    CREATE DATABASE candlepin OWNER candlepin;
    CREATE DATABASE pulpcore OWNER pulp;
    Copy to Clipboard Toggle word wrap
  13. Exit the postgres user:

    # \q
    Copy to Clipboard Toggle word wrap
  14. From Satellite Server, test that you can access the database. If the connection succeeds, the commands return 1.

    # PGPASSWORD='Foreman_Password' psql -h postgres.example.com -p 5432 -U foreman -d foreman -c "SELECT 1 as ping"
    # PGPASSWORD='Candlepin_Password' psql -h postgres.example.com -p 5432 -U candlepin -d candlepin -c "SELECT 1 as ping"
    # PGPASSWORD='Pulpcore_Password' psql -h postgres.example.com -p 5432 -U pulp -d pulpcore -c "SELECT 1 as ping"
    Copy to Clipboard Toggle word wrap

Use the satellite-installer command to configure Satellite to connect to an external PostgreSQL database.

Prerequisites

  • You have installed and configured a PostgreSQL database on a Red Hat Enterprise Linux server.

Procedure

  1. To configure the external databases for Satellite, enter the following command:

    # satellite-installer \
    --katello-candlepin-manage-db false \
    --katello-candlepin-db-host postgres.example.com \
    --katello-candlepin-db-name candlepin \
    --katello-candlepin-db-user candlepin \
    --katello-candlepin-db-password Candlepin_Password \
    --foreman-proxy-content-pulpcore-manage-postgresql false \
    --foreman-proxy-content-pulpcore-postgresql-host postgres.example.com \
    --foreman-proxy-content-pulpcore-postgresql-db-name pulpcore \
    --foreman-proxy-content-pulpcore-postgresql-user pulp \
    --foreman-proxy-content-pulpcore-postgresql-password Pulpcore_Password \
    --foreman-db-manage false \
    --foreman-db-host postgres.example.com \
    --foreman-db-database foreman \
    --foreman-db-username foreman \
    --foreman-db-password Foreman_Password
    Copy to Clipboard Toggle word wrap

    To enable the Secure Sockets Layer (SSL) protocol for these external databases, add the following options:

    --foreman-db-root-cert <path_to_CA>
    --foreman-db-sslmode verify-full
    --foreman-proxy-content-pulpcore-postgresql-ssl true
    --foreman-proxy-content-pulpcore-postgresql-ssl-root-ca <path_to_CA>
    --katello-candlepin-db-ssl true
    --katello-candlepin-db-ssl-ca <path_to_CA>
    --katello-candlepin-db-ssl-verify true
    Copy to Clipboard Toggle word wrap

If your manual configuration has been overwritten by a Puppet run, you can restore the files to the previous state.

For example, when you install and configure Satellite for the first time by using satellite-installer, you can use the --foreman-proxy-dns-managed false and --foreman-proxy-dhcp-managed false options to specify that the DNS and DHCP configuration files are not to be managed by Puppet. If you do not use these options during the initial satellite-installer run, rerunning satellite-installer overwrites all manual changes. The following example shows you how to restore a DHCP configuration file overwritten by a Puppet run.

Procedure

  1. Copy the file you intend to restore. This allows you to compare the files to check for any mandatory changes required by the upgrade. This is not common for DNS or DHCP services.

    # cp /etc/dhcp/dhcpd.conf /etc/dhcp/dhcpd.backup
    Copy to Clipboard Toggle word wrap
  2. Check the log files to note down the md5sum of the overwritten file. For example:

    # journalctl -xe
    ...
    /Stage[main]/Dhcp/File[/etc/dhcp/dhcpd.conf]: Filebucketed /etc/dhcp/dhcpd.conf to puppet with sum 622d9820b8e764ab124367c68f5fa3a1
    ...
    Copy to Clipboard Toggle word wrap
  3. Restore the overwritten file:

    # puppet filebucket restore --local --bucket \
    /var/lib/puppet/clientbucket /etc/dhcp/dhcpd.conf \ 622d9820b8e764ab124367c68f5fa3a1
    Copy to Clipboard Toggle word wrap
  4. Compare the backup file and the restored file, and edit the restored file to include any mandatory changes required by the upgrade.

If your environment changes from disconnected to connected, you can reconfigure a disconnected Satellite Server to download content directly from the Red Hat CDN.

Procedure

  1. In the Satellite web UI, navigate to Content > Subscriptions.
  2. Click Manage Manifest.
  3. Switch to the CDN Configuration tab.
  4. Select Red Hat CDN.
  5. Edit the URL field to point to the Red Hat CDN URL:

    https://cdn.redhat.com

  6. Click Update.

Satellite Server is now configured to download content from the Red Hat CDN the next time that it synchronizes repositories.

CLI procedure

  1. Log in to the Satellite Server using SSH.
  2. Use Hammer to reconfigure the CDN:

    $ hammer organization configure-cdn --name="My_Organization" --type=redhat_cdn
    Copy to Clipboard Toggle word wrap

Legal Notice

Copyright © 2025 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat