Search

Chapter 12. Renaming Satellite Server or Capsule Server

download PDF

To rename Satellite Server or Capsule Server, use the satellite-change-hostname script.

Important

When changing the domain name of your Satellite Server or Capsule Server, update the hostname using satellite-change-hostname to avoid networking issues.

12.1. Renaming Satellite Server

The host name of Satellite Server is used by Satellite Server components, all Capsule Servers, and hosts registered to it for communication. This procedure ensures that in addition to renaming Satellite Server, you also update all references to point to the new host name.

Warning

Renaming your Satellite Server host shuts down all Satellite services on that host. The services restart after the renaming is complete.

Prerequisites

  • Back up your Satellite Server before changing its host name. If you fail to successfully rename it, restore it from the backup. For more information, see Chapter 10, Backing Up Satellite Server and Capsule Server.
  • Run the hostname and hostname -f commands on Satellite Server. If both commands do not return the FQDN of Satellite Server, the satellite-change-hostname script will fail to complete.

    If the hostname command returns the shortname of Satellite Server instead of the FQDN, use hostnamectl set-hostname My_Old_FQDN to set the old FQDN correctly before using the satellite-change-hostname script.

  • If Satellite Server has a custom SSL certificate installed, obtain a new certificate for the new FQDN of the host. For more information, see Configuring Satellite Server with a Custom SSL Certificate in Installing Satellite Server in a Connected Network Environment.

Procedure

  1. On Satellite Server, run the satellite-change-hostname script, and provide the new host name. Choose one of the following methods:

    • If your Satellite Server is installed with the default self-signed SSL certificates, enter the following command:

      # satellite-change-hostname new-satellite \
      --username admin \
      --password password
    • If your Satellite Server is installed with custom SSL certificates:

      # satellite-change-hostname new-satellite \
      --username admin \
      --password password \
      --custom-cert "/root/ownca/test.com/test.com.crt" \
      --custom-key "/root/ownca/test.com/test.com.key"
  2. If you have created a custom SSL certificate for the new Satellite Server host name, run the Satellite installation script to install the certificate. For more information about installing a custom SSL certificate, see Deploying a Custom SSL Certificate to Satellite Server in Installing Satellite Server in a Connected Network Environment.
  3. Reregister all Satellite hosts. For more information, see Registering Hosts in Managing Hosts.
  4. On all Capsule Servers, run the Satellite installation script to update references to the new host name:

    # satellite-installer \
    --foreman-proxy-foreman-base-url https://new-satellite.example.com \
    --foreman-proxy-trusted-hosts new-satellite.example.com \
    --puppet-server-foreman-url https://new-satellite.example.com
  5. On Satellite Server, list all Capsule Servers:

    # hammer capsule list
  6. On Satellite Server, synchronize content for each Capsule Server:

    # hammer capsule content synchronize \
    --id My_capsule_ID
  7. If you use the virt-who agent, update the virt-who configuration files with the new host name. For more information, see Modifying a virt-who Configuration in Configuring Virtual Machine Subscriptions in Red Hat Satellite.
  8. If you use external authentication, reconfigure Satellite Server for external authentication after you run the satellite-change-hostname script. For more information, see Configuring External Authentication in Installing Satellite Server in a Connected Network Environment.

12.2. Renaming Capsule Server

The host name of Capsule Server is referenced by Satellite Server components and all hosts registered to it. This procedure ensures that in addition to renaming Capsule Server, you also update all references to the new host name.

Warning

Renaming your Capsule Server host shuts down all Satellite services on that host. The services restart after the renaming is complete.

Prerequisites

  • Back up your Capsule Server before renaming. If you fail to successfully rename it, restore it from the backup. For more information, see Chapter 10, Backing Up Satellite Server and Capsule Server.
  • Run the hostname and hostname -f commands on Capsule Server. If both commands do not return the FQDN of Capsule Server, the satellite-change-hostname script will fail to complete.

    If the hostname command returns the shortname of Capsule Server instead of the FQDN, use hostnamectl set-hostname My_Old_FQDN to set the old FQDN correctly before attempting to use the satellite-change-hostname script.

Procedure

  1. On Satellite Server, generate a new certificates archive file for Capsule Server.

    • If you are using the default SSL certificate, enter the following command:

      # capsule-certs-generate \
      --foreman-proxy-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.

    • If you are using a custom SSL certificate, create a new SSL certificate for Capsule Server. For more information, see Configuring Capsule Server with a Custom SSL Certificate in Installing Capsule Server.
  2. On Satellite Server, copy the certificates archive file to Capsule Server. For example, to copy the archive file to the root user’s home directory:

    # scp /root/new-capsule.example.com-certs.tar root@capsule.example.com:
  3. On Capsule Server, run the satellite-change-hostname script and provide the host’s new name, Satellite credentials, and certificates archive file name.

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

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

  4. If you have created a custom certificate for Capsule Server, deploy the certificate on Capsule Server by entering the satellite-installer command that the capsule-certs-generate command returned in a previous step. For more information, see Deploying a Custom SSL Certificate to Capsule Server in Installing Capsule Server.
  5. On all Capsule clients, enter the following commands to reinstall the bootstrap RPM, reregister clients, and refresh their subscriptions.

    You can use the remote execution feature to perform this step. For more information, see Configuring and Setting up Remote Jobs in Managing Hosts.

    # dnf remove katello-ca-consumer*
    
    # dnf install http://new-capsule.example.com/pub/katello-ca-consumer-latest.noarch.rpm
    
    # subscription-manager register --org="My_Organization" \
    --environment="Library" \
    --force
    
    # subscription-manager refresh
  6. Update the Capsule host name in the Satellite web UI.

    1. In the Satellite web UI, navigate to Infrastructure > Capsules.
    2. Locate Capsule Server in the list, and click Edit.
    3. Edit the Name and URL fields to match Capsule Server’s new host name, then click Submit.
    4. On your DNS server, add a record for the new hostname of your Capsule Server, and delete the record of the previous host name.
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.

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.

© 2024 Red Hat, Inc.