Activation Keys

The activation keys page can be accessed via The Content Menu:

Content > Activation Keys

The activation keys page forms a part of orcharhino’s content management. (See also: Content Management Guide).

Activation keys are used by the subscription manager to register hosts with orcharhino’s content management. (The subscription manager just is the client side software used to register a host.) When a host registers using a particular key, it will receive a list of repositories associated with the key, which can be used to install new software, update packages or apply errata.

Activation keys are the element of orcharhino’s content management that draws together Content Views, Lifecycle Environments, and Subscriptions (which are in turn closely associated with Products).

Each activation key is associated with exactly one content view and exactly one lifecycle environment. In addition, keys are associated with any number of subscriptions. A given key grants access to the set theoretic intersection, of the repository set present in the key’s content view/lifecycle environment combination, and the repository set present in the key’s subscriptions. See the following image for a visual representation:

The relationship between repositories, products, content views and activation keys

When adding a new host to a host group (see also: Host Groups) it will automatically use any keys associated with that host group for registration with orcharhino’s content management. Existing (but unregistered) hosts, can also be registered using some key. Existing (and registered) hosts can be re-registered using a different key. In such cases it is necessary to refresh the subscription manager (on the host being registered) for changes to take effect:

subscription-manager refresh

Warning

Activation keys should only ever be deleted if you are sure they are not in use by any host groups, host collections or individual hosts. orcharhino may not give a warning when keys are still in use. Deleting a key that is still in use prevents the host from rebuilding successfully.


The activation keys page includes a Create Activation Key button and displays the list of activation keys.

Show the list of available activation keys and the button for creating a new key
  • The Create Activation Key button (1) will take you to the create activation key page. (See Creating an Activation Key below).

  • The list of activation keys (2) displays the configured activation keys.

  • Clicking on the name of an activation key in the Name column (3) will take you to the activation key overview page. (See Viewing an Activation Key below).

Creating an Activation Key

The create activation key page can be accessed via The Content Menu:

Content > Activation Keys >> Create Activation Key

Note

To create an Activation Key, you should already have configured Lifecycle Environments and Content Views since they need to be set for each activation key.

The create activation key page includes several input fields and drop down menus:

Creating a new orcharhino activation key
  • The Name (1) is the only required field. Choose a unique, unused activation key name.

  • Limit the amount of hosts for which this activation key can be used (2).

  • Provide a meaningful description (3).

  • Select the Lifecycle Environments to use (4). Hosts using this activation key are assigned to this lifecycle environment.

  • Depending on the selected Lifecycle Environments the list of Content Views is generated (5). Select the content view to use.

Viewing an Activation Key

The activation key overview page can be accessed via the list of activation keys:

Content > Activation Keys >> list of activation keys > Name column > name of an activation key

An Activation Key overview page displays details of an activation key. An activation key can be edited and subscriptions, or repository sets can be assigned.

Details of an activation key
  • Use the subscription-manager command shown (1) to register a host on orcharhino using this activation key and organization.

  • View and change the name, description, host limit and the service level (2). Service levels are only available for Red Hat hosts in case a Red Hat manifest is used. They allow you to specify the service level of this host, like Standard or Premium.

  • View and change the Release version, Lifecycle Environments and Content Views of the activation key (3). Release version are only available for Red Hat hosts in case a Red Hat manifest is used. They allow you to tie a host to use a specific Red Hat Enterprise Linux version.


Actions on the activation key overview page.

Actions on activation key overview

Two actions on the activation key overview page exists:

  • Copy Activation Key: this action copies an activation key and stores it as a new key. All settings of the activation key are reused. Type in a new, unique name of the copied activation key.

  • Remove: delete the existing activation key.

    Note

    orcharhino may not give a warning when keys are still in use. Deleting a key that is still in use prevents the host from rebuilding successfully.


The subscriptions tab is used to associate subscriptions (see also Subscriptions) to the selected activation key.

Manage subscriptions of an activation key
  • The List/Remove tab (1) displays selected subscriptions of an activation key. It provides a button (4) to remove the selected (5) subscriptions from the activation key.

  • The Add tab (2) displays all available subscriptions of this orcharhino and it provides a button to add the selected subscriptions to the activation key.

  • The Auto-Attach (3) option affects only Red Hat subscriptions and doesn’t influence custom products (like SuSE, CentOS, Debian, customer-related products, etc.).

    In case of enabled Auto-Attach and using a Red Hat operating system, only the subscriptions necessary to run the product are selected automatically while registering. Additionally, all custom subscriptions (= Non Red Hat subscriptions) selected below are used, too.

    If Auto-Attach option is disabled, all selected subscriptions are activated on the host.


The repository sets tab allows you to enable / disable repositories. This view displays all available repositories which would be available for the host when using this activation key.

Note

New repositories added to a product subsequently are enabled by default.

Manage repository sets

Select the repositories (2) you want to change by the selected action (1):

  • Override to Enabled: Force the repository to be activated.

  • Override to Disabled: Force the repository to be deactivated.

  • Reset to Default: Reset the default state.

Note

Disabled repository sets can be manually enabled on subscribed clients. Repository sets should not be viewed as limiting access in the sense of permissions.


The host collections tab allows you to associate an activation key with a Host Collections.

Associate an activation key to host collections
  • The List/Remove tab (1) displays host collections which are using the given activation key. Through the Remove Selected button the association can be deleted.

  • The Add tab (2) allows you to specify that a host collections should use the activation key. Select the host collection (4) and press the Add Selected button (3) afterwards.


The associations / content hosts tab displays Content Hosts which are using the activation key.

Show activation key usage