rPath Appliance Platform/Update Service:Manual Entitlement Setup

From rPath Wiki

In rare circumstances, when the rPath Appliance Platform Entitlement Service is not appropriate for a rPath Appliance Platform Update Service (rUS) deployment, entitlements can be created manually using the web interface to rUS.

Use the steps outlined in the following sections to configure entitlements manually in rUS.

1. Configure the rUS Repository -- Verify the rUS repository and ensure an administrator account is enabled for the repository.
2. Configure the Access Group -- Define the necessary repository access rights for a specific entitlement.
3. Create the Entitlement Class -- Create an entitlement class to be paired with the access rights defined in the access group configuration.
4. Add an Entitlement Key -- Establish the entitlement key used by the external verification web service to grant repository access.

Configure the rUS Repository

The first step in setting up entitlements manually is to define an administrator user for the rUS repository.

If your rUS has an existing administrator user account, proceed to the rUS repository interface step. Use the name and password of the existing administrator account when prompted.

Use the following these steps to create an administrator account for the rUS repository:

1. Click Manage Repository Users.
2. Type a username and password for the administrator account.
3. Check the Admin permission.
4. Click Apply.

After ensuring there is an administrator account, use a web browser to access the rUS repository interface URL ( such as https://rus.example.com/).

When prompted for a name and password, use the administrator username and password that you just created, or provide the credentials for an existing repository administrator.

Configure the Access Group

After signing in to the rUS repository interface, configure a group that defines permissions for a specific class of users:

1. Click Users and Groups.
2. Click Add Group.
3. Type a descriptive name for the group (such as myProduct). You can include a version number in the group name for partitioning of permissions based on product version.
4. Click Add Group.

After creating the group, specify permissions for that group:

1. Click Add Permission.
2. Use the interface to add permissions associated with this group of users. If you do not need to partition permissions, then you can grant access permissions to the entire repository. In that case, click Add to accept the default access permissions.

To partition the access privileges, select the appropriate label and trove versions before adding the permissions.

Create the Entitlement Class

After configuring the group and its permissions, create a new entitlement class. The entitlement class is paired with the access group to grant permissions to the repository. Use the following steps:

1. Sign into the rUS repository interface.
2. Click Manage Entitlements.
3. Click Add Entitlment Class.
4. Type a descriptive name for the Entitlement Class (such as myProduct), and select the group created in the previous section.
5. Click Add Entitlement Class.

Add an Entitlement Key

Add an entitlement key for all users in the newly created entitlement class:

1. Click X in the Manage column for your new entitlement group.
2. Click Add Entitlement.
3. Type a random string as the key (such as 03d59e663c1af9ac33a9949d1193505a8460731e, though you should create a different key other than this example).
4. Click Add Entitlement.

Distribute the new entitlement key as needed to Conary clients (such as Conary-based appliances built with rBuilder) to grant access to the repository.