Subscribing RHEL on IBM Cloud after provisioning issues

This tutorial demonstrates how to subscribe a RHEL instance on IBM Cloud when the initial subscription fails during the first boot, often due to network issues. We’ll walk through how to fix this problem and also cover the different subscription options available, along with how cloud-init helps automate the process.

Test environment

This procedure has been tested on the following RHEL versions and images on IBM Cloud:

VSI profile used: cx3d-2x5

Important Note: IBM may update the subscription process or cloud-init configuration in the future. If this procedure no longer works, please reach out to IBM Cloud Support for help.

Resubscribe RHEL on IBM Cloud after provisioning failure

1. First, verify if your RHEL instance is not subscribed by running:

   subscription-manager status

   Copy code

   If the system is not subscribed, you’ll see something like this:

   +-------------------------------------------+
       System Status Details
    +-------------------------------------------+
    Overall Status: Unknown
   
    \ Checking server status

   Copy code

   Common reasons for subscription failure

   • No network connectivity to the Red Hat subscription endpoint.

   • A forced re-registration using subscription-manager register --force that didn’t complete properly.

2. Run the following command to get the subscription server hostname and port:

   export RHEL_SUBSCRIPTION_HOSTNAME=$(cat /var/lib/cloud/instance/scripts/vendor/part-004 | grep -E "^REDHAT_CAPSULE_SERVER" | cut -d'=' -f 2 | sed 's/"//g')
    export RHEL_SUBSCRIPTION_PORT=8443

   Copy code

   Example (EU region)

   • Hostnames: rhha01.updates.eu-es.iaas.service.networklayer.com, rhha02.updates.eu-es.iaas.service.networklayer.com

   • Port: 8443

3. Use the following command to test if your instance can reach the subscription server:

   

   You should see an output like:

   * Trying 161.26.216.24:8443...
    * Connected to rhha02.updates.eu-es.iaas.service.networklayer.com (161.26.216.24) port 8443 (#0)

   Copy code

   If not, check your security groups and subnet ACLs to make sure traffic is allowed to the host and port.

4. To retry the subscription, restart the cloud-init process with these commands:

   cloud-init clean
    reboot

   Copy code

   This will re-run the cloud-init scripts that handle RHEL subscription.

   How it works

   The subscription happens through a script located at:

   /var/lib/cloud/instance/scripts/vendor/part-004

   This script is triggered by the scripts-vendor module in cloud-init, which runs during the first boot. If you restart cloud-init, it will attempt the subscription again using the data provided by IBM Cloud in the cloud-init volume.

   For reference, see the cloud-init GitHub repository.

RHEL subscription options on IBM Cloud

There are two main subscription models for RHEL on IBM Cloud:

• Bring Your Own License (BYOL)

  In this model, you use your own Red Hat subscription. It’s ideal if your organization already has a Red Hat contract and wants to manage licenses centrally.

  • Use a custom VPC image.

  • Subscription and license activation are handled by you, not IBM.

  • Learn more at BYOL for Linux on IBM Cloud

• IBM-managed subscription

  This model applies when you use official RHEL images from the IBM Cloud catalog.

  • The system is automatically registered during provisioning using cloud-init.

  • IBM provides a cloud-init volume containing all subscription details (activation key, org info, and a few other details).

    To inspect this data, run:

    mkdir /mnt/cloud-init
    mount /dev/$(lsblk -f | grep cidata | awk '{print $1}') /mnt/cloud-init
    cat /mnt/cloud-init/vendor-data

    Copy code

    This file includes the subscription configuration used during the instance setup.

    

How RHEL subscription works with cloud-init

Here's a step-by-step overview of how the RHEL subscription is handled during instance provisioning:

This process is triggered automatically during the first boot using the data provided by IBM Cloud.

Summary

This tutorial shows how to subscribe a RHEL instance on IBM Cloud if the initial attempt fails during the first boot, usually due to network issues. It also explains the different subscription models and how cloud-init helps automate the process.

FAQs

1. How is the cloud-init volume identified?

   The cloud-init volume is identified by the label cidata.

   Run this command:

   lsblk -f | grep cidata

   Copy code

   Example output:

   /dev/vdc: LABEL="cidata" TYPE="iso9660"

   Copy code

   For more details, see the cloud-init GitHub repository.

2. How to subscribe your RHEL OS using rh_subscription in user data?

   You can use the rh_subscription section in your cloud-init user data to register the OS.

   Note: This is not recommended if you're using an IBM-managed Subscription.

   Example:

   rh_subscription:
            rhsm-baseurl: "rhsm-baseurl"
            server-hostname: "server-hostname"
            add-pool: "add-pool"
            activation-key: "activation-key"
            org: "org"
            auto-attach: true
            enable-repo:
              - "rhel-9-for-x86_64-baseos-rpms"
              - "rhel-9-for-x86_64-appstream-rpms"
            service-level: "standard"

   Copy code

3. How to manually register your RHEL OS?

   Note: This is not recommended if you're using an IBM-managed Subscription.

   Method 1:

   Run the following command:

   source /var/lib/cloud/instance/scripts/vendor/part-004

   Copy code

   Method 2:

   You can also use the subscription-manager command. First, get the necessary values from the part-004 file:

   OS_REDHAT_ORG_NAME=$(grep -E "^OS_REDHAT_ORG_NAME" /var/lib/cloud/instance/scripts/vendor/part-004 | cut -d'=' -f 2 | sed 's/"//g')
    ACTIVATION_KEYS=$(grep -E "^ACTIVATION_KEYS" /var/lib/cloud/instance/scripts/vendor/part-004 | awk -F'ACTIVATION_KEYS=' '{print $2}' | sed 's/"//g')
    PROFILENAME=$(grep -E "^PROFILENAME" /var/lib/cloud/instance/scripts/vendor/part-004 | cut -d'=' -f 2 | sed 's/"//g')
    REDHAT_CAPSULE_SERVER=$(grep -E "^REDHAT_CAPSULE_SERVER" /var/lib/cloud/instance/scripts/vendor/part-004 | cut -d'=' -f 2 | sed 's/"//g')

   Copy code

   Then, run the following command to register:

   sudo subscription-manager register --org="${OS_REDHAT_ORG_NAME}" --activationkey="${ACTIVATION_KEYS}" --name="${PROFILENAME}" --baseurl="https://${REDHAT_CAPSULE_SERVER}/pulp/repos" --force

   Copy code

4. How to check the cloud-init datasource?

   You can use either of these commands:

   cloud-init status --long

   Copy code

   or

   cat /var/lib/cloud/instance/datasource

   Copy code

   Expected output:

   DataSourceNoCloud: DataSourceNoCloud [seed=/dev/vdb][dsmode=net]

   Copy code

5. Who mounts the cloud-init volume?

   The DataSourceNoCloud.py file in the cloud-init GitHub repository is responsible for mounting the cloud-init volume.

6. How to unregister your RHEL OS?

   Run the following command:

   subscription-manager unregister

   Copy code

References

• Cloud-Init GitHub repository

• IBM Cloud: Using user data

• IBM Cloud: Using your own OS license or subscription

• IBM Cloud: BYOL for Linux on VPC