Managing Red Hat subscriptions

You can import content from the Red Hat Content Delivery Network (CDN) into orcharhino by using a Red Hat subscription manifest. Manage your subscription allocations to ensure each organization can access and download Red Hat repositories.

A Red Hat subscription manifest contains the information about the subscriptions purchased from Red Hat. orcharhino uses the information in the manifest to access the Red Hat CDN and find what repositories are available for the associated subscription.

You must have a Red Hat subscription manifest containing a subscription allocation for each organization in orcharhino. All subscription information is available on the Red Hat Hybrid Cloud Console.

Subscription allocations and organizations: You can manage more than one organization if you have more than one subscription allocation. orcharhino requires a single allocation for each organization configured in orcharhino Server. The advantage of this is that each organization maintains separate subscriptions so that you can support multiple organizations, each with their own Red Hat accounts.
Future-dated subscriptions: You can use future-dated subscriptions in a subscription manifest. When you add future-dated subscriptions to your manifest before the expiry date of the existing subscriptions, you can have uninterrupted access to repositories.
Subscriptions service: The Subscriptions service on the Red Hat Hybrid Cloud Console helps you track and manage Red Hat subscription usage across connected and disconnected systems. It collects usage data, displays trends in a centralized dashboard, and supports historical analysis for planning and compliance. For more information, see Tracking subscription usage by using the subscriptions service.

Running Red Hat Enterprise Linux on managed hosts requires a subscription from Red Hat. Ensure to provide valid licenses for all used Red Hat products. Using insufficient, invalid, or otherwise inadequate licenses might violate your terms with Red Hat.

We recommend using a Manifest file from your Red Hat account to import available content to orcharhino. Navigate to Content > Subscriptions to see available and consumed Red Hat subscriptions.

Tracking subscription usage by using the Subscriptions service

You can configure your orcharhino Server to report usage data to the Red Hat Hybrid Cloud Console. Track and manage your subscription usage to analyze historical trends for planning and compliance.

Prerequisites

The foreman_rh_cloud plugin is enabled on orcharhino Server. You can enable the plugin by running orcharhino-installer:
```
$ orcharhino-installer --enable-foreman-plugin-rh-cloud
```
Connected orcharhino

In the orcharhino management UI, navigate to Insights > Inventory Upload to configure the foreman_rh_cloud plugin and share inventory information with the Red Hat Hybrid Cloud Console. Ensure that the Automatic Inventory Upload setting is enabled. The plugin enables the subscriptions service to track usage information across connected systems.

You can configure the plugin to omit data that is not needed for subscription tracking, such as host names and IP addresses.

Disconnected orcharhino
Export usage data in one of the following ways:
Use the foreman_rh_cloud plugin to generate a report locally. You can download the report from the orcharhino management UI. The report is in JSON format and is easily integrated for automated scripts or machine processing. You can generate this report by using CLI:

$ foreman-rake rh_cloud_inventory:report:generate

View product usage by running the Host - Installed Products report.

Navigate to Monitor > Reports > Report Templates. You can select the format that you want for the report. YAML, JSON, HTML, and CSV formats are supported.

Importing Red Hat subscription manifests into orcharhino

You can import a Red Hat subscription manifest into orcharhino to provide subscription allocation to your organization in orcharhino.

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.

Obtaining a Red Hat subscription manifest

You can create and export a Red Hat subscription manifest to prepare subscriptions for import into orcharhino.

Importing a Red Hat subscription manifest by using orcharhino management UI

Procedure

You can import a Red Hat subscription manifest into orcharhino Server by using orcharhino management UI. Import the manifest so that you can enable and synchronize Red Hat repositories in your organization.

Prerequisites

You have a Red Hat subscription manifest file. For more information, see Obtaining a red hat subscription manifest.

Procedure

In the orcharhino management UI, ensure the context is set to the organization you want to use.
Navigate to Content > Subscriptions.
Click Manage Manifest.
In the Manage Manifest window, click Choose File.
Navigate to the location that contains the Red Hat subscription manifest file, then click Open.

Importing a Red Hat subscription manifest by using Hammer CLI

You can import a Red Hat subscription manifest into orcharhino Server by using Hammer CLI. Import the manifest so that you can enable and synchronize Red Hat repositories in your organization.

Prerequisites

You have a Red Hat subscription manifest file. For more information, see Obtaining a red hat subscription manifest.

Procedure

Copy the Red Hat subscription manifest file from your local machine to orcharhino Server:
```
$ scp ~/manifest_file.zip root@orcharhino.example.com:~/.
```
Log in to orcharhino Server over SSH as the root user.

Import the Red Hat subscription manifest file:

$ hammer subscription upload \
--file ~/manifest_file.zip \
--organization "My_Organization"

Locating a Red Hat subscription

You can locate specific Red Hat subscriptions in your orcharhino by filtering the results on the Subscriptions page to navigate a high volume of subscriptions.

Prerequisites

A Red Hat subscription manifest is imported to orcharhino. For more information, see Importing Red Hat subscription manifests into orcharhino.

Procedure

In the orcharhino management UI, ensure the context is set to the organization you want to use.
In the orcharhino management UI, navigate to Content > Subscriptions.
In the Subscriptions window, click the Search field to view the list of search criteria for building your search query.
Select search criteria to display further options.
When you have built your search query, click the search icon.

Additional resources

Searching and bookmarking in Administering orcharhino

Adding Red Hat subscriptions to subscription manifests

You can add Red Hat subscriptions to your subscription manifest in orcharhino to allocate entitlements to Red Hat content in your organization.

If you have exported a new subscription manifest from the Red Hat Hybrid Cloud Console, you have to populate the manifest with subscriptions. Such a manifest does not initially contain any subscriptions.

Prerequisites

A Red Hat subscription manifest is imported to orcharhino. For more information, see Importing Red Hat subscription manifests into orcharhino.

Procedure

In the orcharhino management UI, ensure the context is set to the organization you want to use.
Navigate to Content > Subscriptions.
On the Subscriptions page, click Add Subscriptions.
On the row of each subscription you want to add, enter the quantity in the Quantity to Allocate column.
Click Submit.

Removing Red Hat subscriptions from subscription manifests

You can remove Red Hat subscriptions from manifests to adjust entitlement allocations or decommission Red Hat products from your organization.

Manifests must not be deleted. If you delete the manifest from the Red Hat Customer Portal or in the orcharhino management UI, all of the entitlements for all of your hosts will be removed.

Prerequisites

A Red Hat subscription manifest is imported to orcharhino. For more information, see Importing Red Hat subscription manifests into orcharhino.

Procedure

In the orcharhino management UI, ensure the context is set to the organization you want to use.
Navigate to Content > Subscriptions.
On the row of each subscription you want to remove, select the corresponding checkbox.
Click Delete, and then confirm deletion.

Updating and refreshing Red Hat subscription manifests

You can refresh your Red Hat subscription manifests to keep your subscription allocations up to date. Refresh your manifests after renewing, adjusting, or purchasing subscriptions to ensure accurate entitlements in your orcharhino.

Every time you change a subscription allocation, you must refresh the manifest to reflect these changes. For example, you must refresh the manifest if you take any of the following actions:

Renewing a subscription
Adjusting subscription quantities
Purchasing additional subscriptions

You can refresh the manifest directly in the orcharhino management UI. Alternatively, you can import an updated manifest that contains the changes.

The orcharhino management UI provides a notification before the subscription manifest expires.

Prerequisites

A Red Hat subscription manifest is imported to orcharhino. For more information, see Importing Red Hat subscription manifests into orcharhino.

Procedure

In the orcharhino management UI, ensure the context is set to the organization you want to use.
Navigate to Content > Subscriptions.
On the Subscriptions page, click Manage Manifest.
In the Manage Manifest window, click Refresh.

Red Hat CDN structure

The Red Hat Content Delivery Network (CDN) is a geographically distributed series of static web servers providing Red Hat software. You can access this content directly through Subscription Manager or orcharhino Server.

The Red Hat CDN is located at cdn.redhat.com. orcharhino and Subscription Manager configure which content is accessible to your hosts based on your subscription entitlements. orcharhino must authenticate to the Red Hat CDN by using X.509 certificate authentication. The certificate is part of a subscription manifest.

Example 1. Directory structure of the Red Hat CDN

$ tree -d -L 11
└── content
    ├── beta
    │   └── rhel
    │       └── server
    │           └── 7
    │               └── x86_64
    │                   └── sat-tools
    └── dist
        └── rhel
            └── server
                └── 7
                ├── 7.2
                │   └── x86_64
                │       └── kickstart
                └── 7Server
                    └── x86_64
                        └── os

content – Root directory for the content.
beta – Directory responsible for the lifecycle of the content. Common directories include beta (for Beta code), dist (for Production) and eus (For Extended Update Support) directories.
rhel – Directory responsible for the product name. Usually rhel for Red Hat Enterprise Linux.
server – Directory responsible for the type of the product. For Red Hat Enterprise Linux this might include server, workstation, and computenode directories.
7 – Directory responsible for the release version, such as 7, 7.2 or 7Server.
x86_64 – Directory responsible for the base architecture, such as i386 or x86_64.
sat-tools – Directory responsible for the repository name, such as sat-tools, kickstart, rhscl.

Some components have additional subdirectories which might vary.

This directory structure is also used in Red Hat subscription manifests.

The text and illustrations on this page are licensed by ATIX AG under a Creative Commons Attribution Share Alike 4.0 International ("CC BY-SA 4.0") license. This page also contains text from the official Foreman documentation which uses the same license ("CC BY-SA 4.0").