[deployment-guide: 167/185] Standardize admonitions to be descriptive, use sentence case
Jaromir Hradilek
jhradile at fedoraproject.org
Sun May 15 21:25:20 UTC 2011
commit 0b2999fdf16b0ec8cde935ace3052d70cb166405
Author: Douglas Silas <dhensley at redhat.com>
Date: Fri Apr 29 01:00:47 2011 +0200
Standardize admonitions to be descriptive, use sentence case
en-US/Date_and_Time_Configuration.xml | 4 +-
en-US/Keyboard_Configuration.xml | 4 +-
en-US/Managing_Users_and_Groups.xml | 12 +-
en-US/Network_Interfaces.xml | 10 +-
en-US/PackageKit.xml | 4 +-
en-US/Product_Subscriptions_and_Entitlements.xml | 618 +++++++++++-----------
en-US/Yum.xml | 6 +-
7 files changed, 328 insertions(+), 330 deletions(-)
---
diff --git a/en-US/Date_and_Time_Configuration.xml b/en-US/Date_and_Time_Configuration.xml
index f0ce8ec..67f2c80 100644
--- a/en-US/Date_and_Time_Configuration.xml
+++ b/en-US/Date_and_Time_Configuration.xml
@@ -159,7 +159,7 @@
<orderedlist>
<listitem>
<para>
- <emphasis>Using the interactive map.</emphasis> Click “zoom in” and “zoom out” buttons next to the map, or click on the map itself to zoom into the selected region. Then choose the city specific to your time zone. A red <guilabel>X</guilabel> appears and the time zone selection changes in the list below the map.
+ <emphasis>Using the interactive map.</emphasis> Click “zoom in” and “zoom out” buttons next to the map, or click on the map itself to zoom into the selected region. Then choose the city specific to your time zone. A red <guilabel>X</guilabel> appears and the time zone selection changes in the list below the map.
</para>
</listitem>
<listitem>
@@ -339,7 +339,7 @@ Wed Jun 2 11:58:48 CEST 2010</screen>
server 1.rhel.pool.ntp.org
server 2.rhel.pool.ntp.org</screen>
<note>
- <title>Tip</title>
+ <title>Speed up initial synchronization</title>
<para>
To speed the initial synchronization up, add the <command>iburst</command> directive at the end of each server line:
</para>
diff --git a/en-US/Keyboard_Configuration.xml b/en-US/Keyboard_Configuration.xml
index fd97ee0..3b606a9 100644
--- a/en-US/Keyboard_Configuration.xml
+++ b/en-US/Keyboard_Configuration.xml
@@ -83,7 +83,7 @@
</mediaobject>
</figure>
<note>
- <title>Suggestion: Disable Separate Layout for Each Window</title>
+ <title>Disable separate layout for each window</title>
<para>
By default, changing the keyboard layout affects the active window only. This means that if you change the layout and switch to another window, this window will use the old one, which might be confusing. To turn this unfortunate behavior off, unselect the <guilabel>Separate layout for each window</guilabel> check box.
</para>
@@ -96,7 +96,7 @@
</textobject>
</mediaobject>
<para>
- Doing this has its drawbacks though, as you will no longer be able to chose the default layout by selecting the radio button as shown in <xref linkend="fig-keyboard-layouts-default" />. To make the layout the default, simply drag it at the beginning of the list.
+ Doing this has its drawbacks though, as you will no longer be able to chose the default layout by selecting the radio button as shown in <xref linkend="fig-keyboard-layouts-default" />. To make the layout the default, simply drag it at the beginning of the list.
</para>
<mediaobject>
<imageobject>
diff --git a/en-US/Managing_Users_and_Groups.xml b/en-US/Managing_Users_and_Groups.xml
index 7f6ae00..0bb8173 100644
--- a/en-US/Managing_Users_and_Groups.xml
+++ b/en-US/Managing_Users_and_Groups.xml
@@ -112,9 +112,9 @@
To add a new user, click the <guibutton>Add User</guibutton> button. A window as shown in <xref linkend="user-new-fig" /> appears. Type the username and full name for the new user in the appropriate fields. Type the user's password in the <guilabel>Password</guilabel> and <guilabel>Confirm Password</guilabel> fields. The password must be at least six characters.
</para>
<note>
- <title>Tip</title>
+ <title>Password security advice</title>
<para>
- It is advisable to use a much longer password, as this makes it more difficult for an intruder to guess it and access the account without permission. It is also recommended that the password not be based on a dictionary term; use a combination of letters, numbers and special characters.
+ It is advisable to use a much longer password, as this makes it more difficult for an intruder to guess it and access the account without permission. It is also recommended that the password not be based on a dictionary term: use a combination of letters, numbers and special characters.
</para>
</note>
<para>
@@ -612,7 +612,7 @@
To configure password expiration for a user from a shell prompt, use the <command>chage</command> command with an option from <xref linkend="table-chage-options" />, followed by the username.
</para>
<important>
- <title>Important</title>
+ <title>Shadow passwords must be enabled to use chage</title>
<para>
Shadow passwords must be enabled to use the <command>chage</command> command. For more information, see <xref linkend="s1-users-groups-shadow-utilities" />.
</para>
@@ -693,7 +693,7 @@
</tgroup>
</table>
<note>
- <title>Tip</title>
+ <title>chage interactivity</title>
<para>
If the <command>chage</command> command is followed directly by a username (with no options), it displays the current password aging values and allows them to be changed interactively.
</para>
@@ -715,7 +715,7 @@
</para>
<screen><command>passwd</command> <option>-d</option> <replaceable>username</replaceable></screen>
<warning>
- <title>Warning</title>
+ <title>Avoid using null passwords whenever possible</title>
<para>
Using a null password, while convenient, is a highly insecure practice, as any third party can log in first and access the system using the insecure username. Always make sure that the user is ready to log in before unlocking an account with a null password.
</para>
@@ -2471,7 +2471,7 @@ drwxr-xr-x. 4 juan juan 4096 Nov 23 15:09 .mozilla</screen>
</entry>
</row>
<row>
- <entry>
+ <entry>
<systemitem class="username">haldaemon</systemitem>
</entry>
<entry>
diff --git a/en-US/Network_Interfaces.xml b/en-US/Network_Interfaces.xml
index 88be59a..bc19662 100644
--- a/en-US/Network_Interfaces.xml
+++ b/en-US/Network_Interfaces.xml
@@ -254,7 +254,7 @@ ONBOOT=yes</screen>
</screen>
<para>Instead of a custom initscript, use <command>ETHTOOL_OPTS</command> to set the interface speed and duplex settings. Custom initscripts run outside of the network init script lead to unpredictable results during a post-boot network service restart.</para>
<note>
- <title>Note</title>
+ <title>Set "autoneg off" before changing speed or duplex settings</title>
<para>Changing speed or duplex settings almost always requires disabling autonegotiation with the <command>autoneg off</command> option. This needs to be stated first, as the option entries are order-dependent.</para>
</note>
</listitem>
@@ -807,7 +807,7 @@ IDLETIMEOUT=600</screen>
<listitem>
<para>A local <firstterm>loopback interface</firstterm> is often used in testing, as well as being used in a variety of applications that require an IP address pointing back to the same system. Any data sent to the loopback device is immediately returned to the host's network layer.</para>
<warning>
- <title>Warning</title>
+ <title>Do not manually edit the ifcfg-lo script</title>
<para><!-- RHEL5: Never edit the loopback interface script, <filename>/etc/sysconfig/network-scripts/ifcfg-lo</filename>, manually -->The loopback interface script, <filename>/etc/sysconfig/network-scripts/ifcfg-lo</filename>, should never be edited manually. Doing so can prevent the system from operating correctly.</para>
</warning>
</listitem>
@@ -877,7 +877,7 @@ IDLETIMEOUT=600</screen>
<command>ifup eth0</command>
</screen>
<warning>
- <title>Caution</title>
+ <title>Use the ifup and ifdown interface scripts</title>
<para>The <filename>ifup</filename> and <filename>ifdown</filename> interface scripts are the only scripts that the user should use to bring up and take down network interfaces.</para>
<para>The following scripts are described for reference purposes only.</para>
</warning>
@@ -995,7 +995,7 @@ IDLETIMEOUT=600</screen>
</varlistentry>
</variablelist>
<warning>
- <title>Warning</title>
+ <title>Be careful when removing or modifying network scripts!</title>
<para>Removing or modifying any scripts in the <filename>/etc/sysconfig/network-scripts/</filename> directory can cause interface connections to act irregularly or fail. Only advanced users should modify scripts related to a network interface.</para>
</warning>
<para>The easiest way to manipulate all network scripts simultaneously is to use the <command>/sbin/service</command> command on the network service (<filename>/etc/rc.d/init.d/network</filename>), as illustrated the following command:</para>
@@ -1042,7 +1042,7 @@ default 192.168.0.1 dev eth0
10.10.10.0/24 via 10.10.10.1 dev eth1
</screen>
<warning>
- <title>Duplicate Default Gateways</title>
+ <title>Duplicate default gateways</title>
<para>If the default gateway is already assigned from DHCP, the IP command arguments format can cause one of two errors during start-up, or when bringing up an interface from the down state using the <command>ifup</command> command: "RTNETLINK answers: File exists" or 'Error: either "to" is a duplicate, or "<replaceable>X.X.X.X</replaceable>" is a garbage.', where <replaceable>X.X.X.X</replaceable> is the gateway, or a different IP address. These errors can also occur if you have another route to another network using the default gateway. Both of these errors are safe to ignore.</para>
</warning>
<formalpara>
diff --git a/en-US/PackageKit.xml b/en-US/PackageKit.xml
index 512da49..ef1343b 100644
--- a/en-US/PackageKit.xml
+++ b/en-US/PackageKit.xml
@@ -7,7 +7,7 @@
<indexterm>
<primary>PackageKit</primary>
</indexterm>
- <para>Red Hat provides <application>PackageKit</application> for viewing, managing, updating, installing and uninstalling packages<indexterm>
+ <indexterm>
<primary>packages</primary>
<secondary>viewing packages with PackageKit</secondary>
</indexterm>
@@ -47,7 +47,7 @@
<primary>PackageKit</primary>
<secondary>uninstalling packages </secondary>
</indexterm>
- compatible with your system. <application>PackageKit</application> consists of several graphical interfaces that can be opened from the GNOME panel menu, or from the Notification Area when <application>PackageKit</application> alerts you that updates are available. For more information on <application>PackageKit's</application> architecture and available front ends, refer to <xref
+ <para>Red Hat provides <application>PackageKit</application> for viewing, managing, updating, installing and uninstalling packages compatible with your system. <application>PackageKit</application> consists of several graphical interfaces that can be opened from the GNOME panel menu, or from the Notification Area when <application>PackageKit</application> alerts you that updates are available. For more information on <application>PackageKit's</application> architecture and available front ends, refer to <xref
linkend="sec-PackageKit_Architecture"/>.</para>
<section
id="sec-Updating_Packages_with_Software_Update">
diff --git a/en-US/Product_Subscriptions_and_Entitlements.xml b/en-US/Product_Subscriptions_and_Entitlements.xml
index 46a083d..d174bab 100644
--- a/en-US/Product_Subscriptions_and_Entitlements.xml
+++ b/en-US/Product_Subscriptions_and_Entitlements.xml
@@ -17,10 +17,10 @@
Effective asset management requires a mechanism to handle the software inventory — both the type of products and the number of systems that the software is installed on. The subscription service provides that mechanism and gives transparency into both global allocations of subscriptions for an entire organization and the specific subscriptions assigned to a single system.
</para>
<para>
- &OSORG; Subscription Manager works with <command>yum</command> to unite content delivery with subscription management. The Subscription Manager handles only the subscription-system associations. <command>yum</command> or other package management tools handle the actual content delivery. <xref linkend="ch-yum" /> describes how to use <command>yum</command>.
+ Red Hat Subscription Manager works with <command>yum</command> to unite content delivery with subscription management. The Subscription Manager handles only the subscription-system associations. <command>yum</command> or other package management tools handle the actual content delivery. <xref linkend="ch-yum" /> describes how to use <command>yum</command>.
</para>
<para>
- This chapter provides an overview of subscription management in &MAJOROS; and the &OSORG; Subscription Manager tools which are available.
+ This chapter provides an overview of subscription management in &MAJOROS; and the Red Hat Subscription Manager tools which are available.
</para>
<section id="overview-of-entitlements">
<title>An Overview of Managing Subscriptions and Content</title>
@@ -33,7 +33,7 @@
<secondary>overview</secondary>
</indexterm>
<para>
- &MAJOROS; and other &OSORG; products are sold through subscriptions, which make packages available and provide support for a set number of systems. Subscription management clarifies the relationships between local systems and available software resources because it gives a view into <emphasis>where</emphasis> software subscriptions are assigned, apart from installing the packages.
+ &MAJOROS; and other Red Hat products are sold through subscriptions, which make packages available and provide support for a set number of systems. Subscription management clarifies the relationships between local systems and available software resources because it gives a view into <emphasis>where</emphasis> software subscriptions are assigned, apart from installing the packages.
</para>
<section id="the-purpose-of-subscriptions">
<title>The Purpose of Subscription Management</title>
@@ -41,7 +41,7 @@
New government and industry regulations are setting new mandates for businesses to track how their infrastructure assets are used. These changes include legislation like Sarbanes-Oxley in the United States, standards like Payment Card Industry Data Security Standard (PCI-DSS), or accreditation like SAS-70. Software inventory maintenance is increasingly important to meet accounting and governmental standards.
</para>
<para>
- That means that there is increasing pressure on IT administrators to have an accurate, current accounting of the software used on their systems. Generally, this is called <emphasis>software license management</emphasis>; with &OSORG;'s subscription model, this is <emphasis>subscription management</emphasis>.
+ That means that there is increasing pressure on IT administrators to have an accurate, current accounting of the software used on their systems. Generally, this is called <emphasis>software license management</emphasis>; with Red Hat's subscription model, this is <emphasis>subscription management</emphasis>.
</para>
<figure id="fig.ents-compliance">
<title>Managing Subscriptions for Software Inventory</title>
@@ -92,21 +92,21 @@
</itemizedlist>
<para>
- With &OSORG;'s commitment to free and open software, subscription management is focused on delivering tools that help IT administrators monitor their software/systems inventory for their own benefit. Subscription management <emphasis>does not</emphasis> enforce or restrict access to products.
+ With Red Hat's commitment to free and open software, subscription management is focused on delivering tools that help IT administrators monitor their software/systems inventory for their own benefit. Subscription management <emphasis>does not</emphasis> enforce or restrict access to products.
</para>
<important>
- <title>Important</title>
+ <title>The Red Hat License Agreement</title>
<para>
- Most &OSORG; products are licensed under a GNU Public License (GPL), which allows free use of the software or code; this a different license than the &OSORG; license agreement. A &OSORG; license provides access to &OSORG; services, like the Customer Portal and Content Delivery Network.
+ Most Red Hat products are licensed under a GNU Public License (GPL), which allows free use of the software or code; this a different license than the Red Hat license agreement. A Red Hat license provides access to Red Hat services, like the Customer Portal and Content Delivery Network.
</para>
<para>
- The &OSORG; subscription requires that, as long as there is any active subscription for a product, then every system which uses the &OSORG; product must have an active subscription assigned to it. Otherwise, the subscription is violated. See <ulink url="http://www.redhat.com/subscriptions/">http://www.redhat.com/subscriptions/</ulink> and <ulink url="http://www.redhat.com/rhel/renew/faqs/#6">http://www.redhat.com/rhel/renew/faqs/#6</ulink> for more information on &OSORG;'s subscription model and terms.
+ The Red Hat subscription requires that, as long as there is any active subscription for a product, then every system which uses the Red Hat product must have an active subscription assigned to it. Otherwise, the subscription is violated. See <ulink url="http://www.redhat.com/subscriptions/">http://www.redhat.com/subscriptions/</ulink> and <ulink url="http://www.redhat.com/rhel/renew/faqs/#6">http://www.redhat.com/rhel/renew/faqs/#6</ulink> for more information on Red Hat's subscription model and terms.
</para>
</important>
</section>
-
+
<section id="defining-entitlements">
<title>Defining Subscriptions, Entitlements, and Products</title>
<indexterm>
@@ -121,10 +121,10 @@
The basis of everything is a <emphasis>subscription</emphasis>. A subscription contains both the <emphasis>products</emphasis> that are available, the support levels, and the <emphasis>quantities</emphasis>, or number of servers, that the product can be installed on.
</para>
<para>
- Subscriptions are managed though the Certificate-Based &OSORG; Network service, which ties into the Entitlements and Content Delivery Network (CDN).
+ Subscriptions are managed though the Certificate-Based Red Hat Network service, which ties into the Entitlements and Content Delivery Network (CDN).
</para>
<para>
- The subscription service maintains a complete list of subscriptions for an organization, identified by a unique ID (called a <emphasis>pool ID</emphasis>). A system is <emphasis>registered</emphasis>, or added, to the subscription service to allow it to manage the subscriptions for that system. Like the subscription, the system is also added to the subscription service inventory and is assigned a unique ID within the service. The subscriptions and system entries, together, comprise the <emphasis>inventory</emphasis>.
+ The subscription service maintains a complete list of subscriptions for an organization, identified by a unique ID (called a <emphasis>pool ID</emphasis>). A system is <emphasis>registered</emphasis>, or added, to the subscription service to allow it to manage the subscriptions for that system. Like the subscription, the system is also added to the subscription service inventory and is assigned a unique ID within the service. The subscriptions and system entries, together, comprise the <emphasis>inventory</emphasis>.
</para>
<para>
A system allocates one of the quantities of a product in a subscription to itself. When a subscription is consumed, it is an <emphasis>entitlement</emphasis>. (An entitlement is roughly analogous to a user license, in that it grants all of the rights to that product to that system. Unlike a user license, an entitlement doesn't grant the right to <emphasis>use</emphasis> the software; with the subscription model, an entitlement grants the ability to download the packages and receive updates.) Because the available quantity in a subscription lowers once a system subscribe to it, the system <emphasis>consumes</emphasis> the subscription.
@@ -140,11 +140,10 @@
</figure>
<para>
- The repository where the product software is located is organized according to the <emphasis>product</emphasis>. Each product group within
- the repository may contain the primary software packages and then any required dependencies or associated packages. Altogether, the product and its
- associated packages are called a <emphasis>content set</emphasis>. (A content set for a product even includes other versions of the product.)
- When a subscription grants access to a product, it includes access to all of the
- associated packages in that content set.
+ The repository where the product software is located is organized according to the <emphasis>product</emphasis>. Each product group within
+ the repository may contain the primary software packages and then any required dependencies or associated packages. Altogether, the product and its
+ associated packages are called a <emphasis>content set</emphasis>. (A content set for a product even includes other versions of the product.)
+ When a subscription grants access to a product, it includes access to all of the associated packages in that content set.
</para>
<para>
A single subscription can have multiple products, and each system can have multiple different subscriptions, depending on how many entitlement certificates are loaded on the machine.
@@ -164,11 +163,11 @@
The subscription tools can display even incompatible entitlements. Alternatively, the architecture definition for the system can be overridden by defining custom system facts for the subscription tools to use.
</para>
<para>
- It's important to distinguish between subscribing to a product and installing a product. A subscription is essentially a statement of whatever products an organization has purchased. The act of subscribing to a subscription means that a system is allowed to install the product with a valid certificate, but subscribing doesn't actually perform any installation or updates. In the reverse, a product can also be installed apart from any entitlements for the system; the system is just does not have a valid product certificate. Certificate-Based &OSORG; Network and the Content Delivery Network harmonize with content delivery and installation by using <command>yum</command> plug-ins that come with the Subscription Manager tools.
+ It's important to distinguish between subscribing to a product and installing a product. A subscription is essentially a statement of whatever products an organization has purchased. The act of subscribing to a subscription means that a system is allowed to install the product with a valid certificate, but subscribing doesn't actually perform any installation or updates. In the reverse, a product can also be installed apart from any entitlements for the system; the system is just does not have a valid product certificate. Certificate-Based Red Hat Network and the Content Delivery Network harmonize with content delivery and installation by using <command>yum</command> plug-ins that come with the Subscription Manager tools.
</para>
</section>
-
+
<section id="rhsm-tools">
<title>Subscription Management Tools</title>
<indexterm>
@@ -180,21 +179,21 @@
<secondary>client tools</secondary>
</indexterm>
<para>
- Subscriptions are managed through GUI and CLI tools called <emphasis>&OSORG; Subscription Manager</emphasis>. The Subscription Manager tracks and displays what entitlements are available to the local system and what entitlements have been consumed by the local system. The Subscription Manager works as a conduit back to the subscription service to synchronize changes like available product quantities or subscription expiration and renewals.
+ Subscriptions are managed through GUI and CLI tools called <emphasis>Red Hat Subscription Manager</emphasis>. The Subscription Manager tracks and displays what entitlements are available to the local system and what entitlements have been consumed by the local system. The Subscription Manager works as a conduit back to the subscription service to synchronize changes like available product quantities or subscription expiration and renewals.
</para>
<note>
- <title>Note</title>
+ <title>Red Hat Subscription Manager tools</title>
<para>
- The &OSORG; Subscription Manager tools are always run as <command>root</command> because of the nature of the changes to the system. However, &OSORG; Subscription Manager connects to the subscription service as a user account for the Customer Service Portal.
+ The Red Hat Subscription Manager tools are always run as <command>root</command> because of the nature of the changes to the system. However, Red Hat Subscription Manager connects to the subscription service as a user account for the Customer Service Portal.
</para>
</note>
<para>
- The Subscription Manager handles both registration and subscriptions for a system. The Subscription Manager is part of the <command>firstboot</command> process for configuring content and updates, but the system can be registered at any time through the &OSORG; Subscription Manager GUI or CLI. New subscriptions, new products, and updates can be viewed and applied to a system through the &OSORG; Subscription Manager tools.
+ The Subscription Manager handles both registration and subscriptions for a system. The Subscription Manager is part of the <command>firstboot</command> process for configuring content and updates, but the system can be registered at any time through the Red Hat Subscription Manager GUI or CLI. New subscriptions, new products, and updates can be viewed and applied to a system through the Red Hat Subscription Manager tools.
</para>
</section>
-
+
<section id="entitlement-arch">
<title>Subscription and Content Architecture</title>
<indexterm>
@@ -253,15 +252,15 @@
The subscription service handles the system registration (verifying that the system is allowed to access the content). It also supplies the system with information on what products are available and handles a central list of entitlements and remaining quantities for the entire organization.
</para>
<para>
- The content delivery network is responsible for delivering the content to the system when requested. The content server is configured in the &OSORG; Subscription Manager configuration and then tied into the system's <command>yum</command> service through the &OSORG; Subscription Manager yum plug-in.
+ The content delivery network is responsible for delivering the content to the system when requested. The content server is configured in the Red Hat Subscription Manager configuration and then tied into the system's <command>yum</command> service through the Red Hat Subscription Manager yum plug-in.
</para>
<para>
- Both the entitlement server and the content server used by a system's &OSORG; Subscription Manager tools can be customized. The default settings use the public subscription service and Content Delivery Network, but either one can be changed to use organization-specific services<!-- or content mirrors-->.
+ Both the entitlement server and the content server used by a system's Red Hat Subscription Manager tools can be customized. The default settings use the public subscription service and Content Delivery Network, but either one can be changed to use organization-specific services<!-- or content mirrors-->.
</para>
<note>
<title>Note</title>
<para>
- Systems have the option of using the older &OSORG; Network and Satellite 5.x systems to deliver content. These content delivery mechanisms bypass the subscription service in Certificate-Based &OSORG; Network, so there is no entitlement management.
+ Systems have the option of using the older Red Hat Network and Satellite 5.x systems to deliver content. These content delivery mechanisms bypass the subscription service in Certificate-Based Red Hat Network, so there is no entitlement management.
</para>
</note>
@@ -296,18 +295,18 @@
</listitem>
</itemizedlist>
<para>
- Dependencies are common and can be handled directly when processing content through tools like <command>yum</command>.
+ Dependencies are common and can be handled directly when processing content through tools like <command>yum</command>.
</para>
<para>
Modifiers can be more subtle. A modifier subscription extends another entitlement and provides different repository access and support than the product entitlement alone.
</para>
<para>
- If the system is subscribed to that product entitlement or combination of products, then the modifier subscription brings an enhanced <emphasis>content set</emphasis> for that product. The content set can include additional new products, new functionality, or extended service and support, depending on the product being modified.
+ If the system is subscribed to that product entitlement or combination of products, then the modifier subscription brings an enhanced <emphasis>content set</emphasis> for that product. The content set can include additional new products, new functionality, or extended service and support, depending on the product being modified.
</para>
<para>
One simple example of a modifier is <emphasis>extended update support</emphasis> (EUS), which extends support for a minor release of &MAJOROS; from six months to 18 months. An EUS subscription provides an enhanced support path, rather than a new product. EUS works only in conjunction with another product, to extend its support profile; it does not stand alone.
</para>
- <note><title>Note</title>
+ <note><title>&MAJOROS; addons and EUS subscriptions</title>
<para>
&MAJOROS; add-ons have access to EUS streams as long as the underlying &MAJOROS; product has an EUS subscription. For example, if an administrator has a &MAJOROS; 2 Socket subscription, a File System subscription, and a &MAJOROS; 2 Socket EUS subscription, then the system can access both non-EUS and EUS content for both the &MAJOROS; server and the File System product.
</para>
@@ -316,13 +315,13 @@
<section id="ents-special-types"><title>Special Consumer Scenarios</title>
<para>
- Many consumers will be physical machines which require subscriptions available through an organization's account. There are different
- types of consumers and different ways of handling consumers. Two scenarios are common: virtual guests and server domains. Both types of
- consumers are handled transparently in the subscription service and in the &OSORG; Subscription Manager tools.
- There is no additional configuration or difference in management for different types of consumers.
+ Many consumers will be physical machines which require subscriptions available through an organization's account. There are different
+ types of consumers and different ways of handling consumers. Two scenarios are common: virtual guests and server domains. Both types of
+ consumers are handled transparently in the subscription service and in the Red Hat Subscription Manager tools.
+ There is no additional configuration or difference in management for different types of consumers.
Information about virtual guests and domain consumers is supplied to help administrators plan and understand their IT environment more fully.
</para>
-
+
<section id="ents-virtual"><title>Virtual Guests and Hosts</title>
<indexterm>
<primary>&MAJOROS;</primary>
@@ -332,11 +331,11 @@
<primary>entitlements</primary>
<secondary>and virtual machines</secondary>
</indexterm>
-
+
<para>
- Some &MAJOROS; variants are specifically planned for virtual hosts and guests. The corresponding subscriptions are divided into a certain quantity of physical hosts and then a quantity of allowed guests. &MAJOROS; add-ons may even be inherited, so that when a host machine is subscribed to that entitlement, all of its guests are automatically included in that subscription. (&OSORG; layered products usually do not draw any distinction between virtual and physical systems; the same type of subscription is used for both.)
+ Some &MAJOROS; variants are specifically planned for virtual hosts and guests. The corresponding subscriptions are divided into a certain quantity of physical hosts and then a quantity of allowed guests. &MAJOROS; add-ons may even be inherited, so that when a host machine is subscribed to that entitlement, all of its guests are automatically included in that subscription. (Red Hat layered products usually do not draw any distinction between virtual and physical systems; the same type of subscription is used for both.)
</para>
- <note><title>Note</title>
+ <note><title>Physical versus virtual machines</title>
<para>
The distinction of being a physical machine versus virtual machine matters only in the priority of how entitlements are consumed. Virtual machines are recorded in the subscription service inventory as a regular <systemitem>system</systemitem> type of consumer.
</para>
@@ -348,7 +347,7 @@
Virtual entitlements can only be used by virtual machines. Physical entitlements can be used by both physical and virtual machines. When ascertaining what subscriptions are available for autosubscription, preference is given first to virtual entitlements (which are more restrictive in the type of consumer which can use them), and then to physical entitlements.
</para>
<para>
- When the &OSORG; Subscription Manager process checks the system facts, it attempts to identify whether the system is a physical machine or a virtual guest. The Subscription Manager can detect guests for several different virtualization services, including:
+ When the Red Hat Subscription Manager process checks the system facts, it attempts to identify whether the system is a physical machine or a virtual guest. The Subscription Manager can detect guests for several different virtualization services, including:
</para>
<itemizedlist>
<listitem>
@@ -366,7 +365,7 @@
HyperV
</para>
</listitem>
-
+
<listitem>
<para>
VMWare ESX
@@ -377,7 +376,7 @@
For any of these virtualization services, the Subscription Manager checks to see if the system is a guest. If it is, then virtual entitlements are listed with the available subscriptions. If no more virtual entitlements are available, then the subscription service will apply physical entitlements.
</para>
</section>
-
+
<section id="ents-domains"><title>Domains</title>
<indexterm>
<primary>&MAJOROS;</primary>
@@ -409,34 +408,34 @@
The best example of a domain is an IPA domain<footnote><para>While an IPA domain is related to identity and authentication, a domain can have any kind of purpose or function.</para></footnote>.
</para>
<para>
- On &OSORG; systems, the IPA servers are available by default and allow an identity server and up to 25 clients to be installed without requiring any additional entitlements. Each individual server in the domain is registered to the subscription service as a <systemitem>system</systemitem> consumer. To allow replication between the servers in the domain, then each server must subscribe (individually) to the appropriate IPA replication system entitlements.
+ On Red Hat systems, the IPA servers are available by default and allow an identity server and up to 25 clients to be installed without requiring any additional entitlements. Each individual server in the domain is registered to the subscription service as a <systemitem>system</systemitem> consumer. To allow replication between the servers in the domain, then each server must subscribe (individually) to the appropriate IPA replication system entitlements.
</para>
<para>
To have more than 25 servers in the IPA domain — both servers and clients, regardless of replication — requires an additional <systemitem>domain</systemitem> entitlement to set the new quantity. The domain entitlement identifies how many clients can be in the domain; rather than being consumed by any one server, the subscription is bound to the domain itself. A server on the domain consumes the domain entitlement and then the entitlement is replicated to the other servers in the domain.
</para>
<para>
- The entire domain is bound to the subscriptions when one of the domain servers subscribes to the <systemitem>domain</systemitem> entitlements using the &OSORG; Subscription Manager tools, and the entitlement certificate is replicated between the domain servers.
+ The entire domain is bound to the subscriptions when one of the domain servers subscribes to the <systemitem>domain</systemitem> entitlements using the Red Hat Subscription Manager tools, and the entitlement certificate is replicated between the domain servers.
</para>
<para>
- The domain entitlement simply governs the behavior of the domain. A domain entitlement is not limited to a specific type of behavior. For an IPA domain, the entitlement sets the quantity of client servers that are in the domain, but other types of domains may have other types of domain entitlements that describe other types of behavior, such as stirage quotas or the maximum number of messages to process per day.
+ The domain entitlement simply governs the behavior of the domain. A domain entitlement is not limited to a specific type of behavior. For an IPA domain, the entitlement sets the quantity of client servers that are in the domain, but other types of domains may have other types of domain entitlements that describe other types of behavior, such as stirage quotas or the maximum number of messages to process per day.
</para>
</section>
</section>
- <section id="rhn-v-rhnclassic"><title>&OSORG; Network versus RHN Classic</title>
+ <section id="rhn-v-rhnclassic"><title>Red Hat Network versus RHN Classic</title>
<para>
- During the firstboot process, there are two options given for the content server: &OSORG; Network and RHN Classic. These systems are mutually exclusive, but they both handle software content and updates as well as subscriptions and system inventory.
+ During the firstboot process, there are two options given for the content server: Red Hat Network and RHN Classic. These systems are mutually exclusive, but they both handle software content and updates as well as subscriptions and system inventory.
</para>
<important><title>Important</title>
<para>
- This entire chapter deals with entitlement and subscription management through &OSORG; Network with the subscription service tools. This is the recommended content/subscription system for &MAJOROS; 6.1 machines.
+ This entire chapter deals with entitlement and subscription management through Red Hat Network with the subscription service tools. This is the recommended content/subscription system for &MAJOROS; 6.1 machines.
</para>
</important>
<para>
- In &MAJOROSVER;, entitlements and subscriptions are defined by <emphasis>available and installed products</emphasis>. However, in older versions of &MAJOROS;, subscriptions were defined by <emphasis>channel access</emphasis>. These are two different approaches to content and entitlement access. &OSORG; Network uses the product-based subscription model, while RHN Classic uses the channel-based model.
+ In &MAJOROSVER;, entitlements and subscriptions are defined by <emphasis>available and installed products</emphasis>. However, in older versions of &MAJOROS;, subscriptions were defined by <emphasis>channel access</emphasis>. These are two different approaches to content and entitlement access. Red Hat Network uses the product-based subscription model, while RHN Classic uses the channel-based model.
</para>
<para>
- &OSORG; Network is focused on two things:
+ Red Hat Network is focused on two things:
</para>
<itemizedlist>
<listitem>
@@ -451,13 +450,13 @@
</listitem>
</itemizedlist>
<para>
- &OSORG; Network is an integration of the Customer Portal, Content Delivery Network, and subscription service (subscription management). It uses simple and streamlined local tools (the &OSORG; Subscription Manager client) to give greater visibility into how entitlements and subscriptions are used and assigned and to help control software subscriptions as they are added and expire.
+ Red Hat Network is an integration of the Customer Portal, Content Delivery Network, and subscription service (subscription management). It uses simple and streamlined local tools (the Red Hat Subscription Manager client) to give greater visibility into how entitlements and subscriptions are used and assigned and to help control software subscriptions as they are added and expire.
</para>
<para>
- Since the client tools for subscription manager (the focus of &OSORG; Network) are only available in &MAJOROS; 6.1 systems and later, &OSORG; Network can only be utilized by 6.1 systems.
+ Since the client tools for subscription manager (the focus of Red Hat Network) are only available in &MAJOROS; 6.1 systems and later, Red Hat Network can only be utilized by 6.1 systems.
</para>
<para>
- RHN Classic uses the traditional channel entitlement model, which provides a global view of content access but does not provide insight into system-level subscription uses. Along with content and global subscription management, RHN Classic also provides some systems management functions:
+ RHN Classic uses the traditional channel entitlement model, which provides a global view of content access but does not provide insight into system-level subscription uses. Along with content and global subscription management, RHN Classic also provides some systems management functions:
</para>
<itemizedlist>
<listitem>
@@ -472,7 +471,7 @@
</listitem>
<listitem>
<para>
- Running scripts
+ Running scripts
</para>
</listitem>
<listitem>
@@ -482,24 +481,24 @@
</listitem>
</itemizedlist>
<para>
- Satellite 5.x systems use a channel-based model similar to RHN Classic.
+ Satellite 5.x systems use a channel-based model similar to RHN Classic.
</para>
<para>
- While RHN Classic has an expanded systems management feature set, RHN Classic does not provide the system-level view into installed and subscribed products that the enhanced &OSORG; Network and subscription service do. RHN Classic is provided for older &MAJOROS; systems (&MAJOROS; 4.x, &MAJOROS; 5.x, and Satellite 5.x) to migrate systems over to Red Hat Enterprise Linux 6.1 and later version.
+ While RHN Classic has an expanded systems management feature set, RHN Classic does not provide the system-level view into installed and subscribed products that the enhanced Red Hat Network and subscription service do. RHN Classic is provided for older &MAJOROS; systems (&MAJOROS; 4.x, &MAJOROS; 5.x, and Satellite 5.x) to migrate systems over to Red Hat Enterprise Linux 6.1 and later version.
</para>
<para>
- When a system is registered with RHN Classic, then the &OSORG; Subscription Manager shows an error that the system is already registered and cannot be managed by the Subscription Manager tools. Likewise, similar errors are returned in the RHN Classic tools if a system is registered with &OSORG; Network and the subscription service.
+ When a system is registered with RHN Classic, then the Red Hat Subscription Manager shows an error that the system is already registered and cannot be managed by the Subscription Manager tools. Likewise, similar errors are returned in the RHN Classic tools if a system is registered with Red Hat Network and the subscription service.
</para>
</section>
</section>
-
+
<section id="launching-ents-tools">
- <title>Using &OSORG; Subscription Manager Tools</title>
+ <title>Using Red Hat Subscription Manager Tools</title>
<indexterm>
- <primary>&OSORG; Subscription Manager</primary>
+ <primary>Red Hat Subscription Manager</primary>
</indexterm>
<para>
- The &OSORG; Subscription Manager tool set encompasses three different tools:
+ The Red Hat Subscription Manager tool set encompasses three different tools:
</para>
<itemizedlist>
<listitem>
@@ -524,27 +523,27 @@
<note>
<title>Note</title>
<para>
- Both the &OSORG; Subscription Manager GUI and CLI must be run as <command>root</command>.
+ Both the Red Hat Subscription Manager GUI and CLI must be run as <command>root</command>.
</para>
</note>
<section id="launching-rhsm">
- <title>Launching &OSORG; Subscription Manager</title>
+ <title>Launching Red Hat Subscription Manager</title>
<indexterm>
<primary>entitlements</primary>
<secondary>client tools</secondary>
- <tertiary>launching &OSORG; Subscription Manager</tertiary>
+ <tertiary>launching Red Hat Subscription Manager</tertiary>
</indexterm>
<indexterm>
<primary>subscriptions</primary>
<secondary>client tools</secondary>
- <tertiary>launching &OSORG; Subscription Manager</tertiary>
+ <tertiary>launching Red Hat Subscription Manager</tertiary>
</indexterm>
<para>
- &OSORG; Subscription Manager is listed as one of the administrative tools in the <guimenu>System => Administration</guimenu> menu in the top management bar.
+ Red Hat Subscription Manager is listed as one of the administrative tools in the <guimenu>System => Administration</guimenu> menu in the top management bar.
</para>
<figure id="fig.rhsm-menu">
- <title>&OSORG; Subscription Manager Menu Option</title>
+ <title>Red Hat Subscription Manager Menu Option</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/rhsm-menu-item.png" />
@@ -554,15 +553,15 @@
</figure>
<para>
- Alternatively, the &OSORG; Subscription Manager GUI can be opened from the command line with a single command:
+ Alternatively, the Red Hat Subscription Manager GUI can be opened from the command line with a single command:
</para>
-
+
<programlisting language="Bash">[root at server1 ~]# subscription-manager-gui</programlisting>
<para>
- The &OSORG; Subscription Manager UI has a single window with tabbed sections that offer quick views into the current state of the system, showing installed products, subscriptions for the system, and available subscriptions the system has access to. These tabs also allow administrators to manage subscriptions by subscribing and unsubscribing the system.
+ The Red Hat Subscription Manager UI has a single window with tabbed sections that offer quick views into the current state of the system, showing installed products, subscriptions for the system, and available subscriptions the system has access to. These tabs also allow administrators to manage subscriptions by subscribing and unsubscribing the system.
</para>
<para>
- The &OSORG; Subscription Manager has three main areas to manage products and subscriptions:
+ The Red Hat Subscription Manager has three main areas to manage products and subscriptions:
</para>
<itemizedlist>
<listitem>
@@ -586,7 +585,7 @@
</itemizedlist>
<figure id="fig.rhsm-gui-overview">
- <title>&OSORG; Subscription Manager Main Screen</title>
+ <title>Red Hat Subscription Manager Main Screen</title>
<mediaobject>
<imageobject>
<imagedata fileref="images/rhsm-subscribe-prod.png" />
@@ -600,7 +599,7 @@
</para>
</section>
-
+
<section id="about-ents-cli-script">
<title>About subscription-manager</title>
<indexterm>
@@ -614,9 +613,9 @@
<tertiary>CLI commands</tertiary>
</indexterm>
<para>
- Any of the operations that can be performed through the &OSORG; Subscription Manager UI can also be performed by running the <command>subscription-manager</command> tool. This tools has the following format:
+ Any of the operations that can be performed through the Red Hat Subscription Manager UI can also be performed by running the <command>subscription-manager</command> tool. This tools has the following format:
</para>
-
+
<programlisting>[root at server1 ~]# subscription-manager <replaceable>command [options]</replaceable></programlisting>
<para>
Each command has its own set of <emphasis>options</emphasis> that are used with it. The <command>subscription-manager</command> help and manpage have more information.
@@ -737,28 +736,28 @@
</table>
</section>
-
+
<section id="about-rhsm-web">
<title>Looking at RHN Subscription Management</title>
<indexterm>
<primary>entitlements</primary>
<secondary>client tools</secondary>
- <tertiary>about &OSORG; Subscription Manager web client</tertiary>
+ <tertiary>about Red Hat Subscription Manager web client</tertiary>
</indexterm>
<indexterm>
<primary>subscriptions</primary>
<secondary>client tools</secondary>
- <tertiary>about &OSORG; Subscription Manager web client</tertiary>
+ <tertiary>about Red Hat Subscription Manager web client</tertiary>
</indexterm>
<para>
The ultimate goal of entitlement management is <emphasis>to allow administrators to identify the relationship between their systems and the subscriptions used by those systems</emphasis>. This can be done from two different perspectives: from the perspective of the local system looking externally to potential subscriptions and from the perspective of the organization, looking down at the total infrastructure of systems and all subscriptions.
</para>
<para>
- The &OSORG; Subscription Manager GUI and CLI are both local clients which manage only the local machine. These tools are somewhat limited in their view; they only disclose information (such as available entitlements) from the perspective of that one system, so expired and depleted subscriptions or subscriptions for other architectures aren't displayed.
+ The Red Hat Subscription Manager GUI and CLI are both local clients which manage only the local machine. These tools are somewhat limited in their view; they only disclose information (such as available entitlements) from the perspective of that one system, so expired and depleted subscriptions or subscriptions for other architectures aren't displayed.
</para>
<para>
- RHN Subscription Management in the Customer Portal is a <emphasis>global</emphasis> tool which is intended to give complete, organization-wide views into subscriptions and systems. It shows all subscriptions and all consumers for the entire organization. RHN Subscription Management can perform many of the tasks of the local tools, like registering consumers, assigning subscriptions, and viewing system facts and UUID. It can also manage the subscriptions themselves, such as viewing contract information and renewing subscriptions — a task not possible in the local clients.
+ RHN Subscription Management in the Customer Portal is a <emphasis>global</emphasis> tool which is intended to give complete, organization-wide views into subscriptions and systems. It shows all subscriptions and all consumers for the entire organization. RHN Subscription Management can perform many of the tasks of the local tools, like registering consumers, assigning subscriptions, and viewing system facts and UUID. It can also manage the subscriptions themselves, such as viewing contract information and renewing subscriptions — a task not possible in the local clients.
</para>
<figure id="fig.ents-rhsm-web-mainpage">
<title>RHN Subscription Management in the Customer Portal</title>
@@ -787,7 +786,7 @@
</section>
</section>
-
+
<section id="registering-machine-ui">
<title>Registering, Unregistering, and Reregistering a System</title>
<indexterm>
@@ -827,7 +826,7 @@
<secondary>registering</secondary>
</indexterm>
<para>
- Entitlements are managed by organizing and maintaining the systems which use entitlement subscriptions. The entitlements and subscriptions are managed by &OSORG; through the subscription service. A system is recognized to the subscription service by being <emphasis>registered</emphasis> with the service. The subscription service assigns the system (called a <emphasis>consumer</emphasis>) a unique ID (essentially as an inventory number) and issues that system an identifying certificate (with the UUID in its subject CN) to identify that system.
+ Entitlements are managed by organizing and maintaining the systems which use entitlement subscriptions. The entitlements and subscriptions are managed by Red Hat through the subscription service. A system is recognized to the subscription service by being <emphasis>registered</emphasis> with the service. The subscription service assigns the system (called a <emphasis>consumer</emphasis>) a unique ID (essentially as an inventory number) and issues that system an identifying certificate (with the UUID in its subject CN) to identify that system.
</para>
<para>
Whenever a subscription is purchased by an organization, the consumer can <emphasis>subscribe</emphasis> to that subscription. This means that a portion of the subscription is allocated to that consumer ID; when the consumer contacts the content delivery network and downloads the software, the licenses have been already assigned to the system. The system has valid certificates for its subscriptions.
@@ -855,9 +854,9 @@
<orderedlist>
<listitem>
<para>
- Launch the &OSORG; Subscription Manager GUI. For example:
+ Launch the Red Hat Subscription Manager GUI. For example:
</para>
-
+
<screen>subscription-manager-gui</screen>
</listitem>
@@ -895,7 +894,7 @@
</orderedlist>
</section>
-
+
<section id="registering-cmd">
<title>Registering from the Command Line</title>
<indexterm>
@@ -914,18 +913,18 @@
<tertiary>from the command line</tertiary>
</indexterm>
<para>
- The simplest way to register a machine is to pass the <command>register</command> command with the user account information required to authenticate to the Certificate-Based &OSORG; Network (the credentials used to access subscription service or the Customer Portal). When the system is successfully authenticated, it echoes back the newly-assigned consumer ID and the user account name which registered it.
+ The simplest way to register a machine is to pass the <command>register</command> command with the user account information required to authenticate to the Certificate-Based Red Hat Network (the credentials used to access subscription service or the Customer Portal). When the system is successfully authenticated, it echoes back the newly-assigned consumer ID and the user account name which registered it.
</para>
<example id="ex.ents-register">
<title>Registering a New Consumer</title>
-
+
<screen>[root at server1 ~]# subscription-manager register --username admin-example --password secret
7d133d55-876f-4f47-83eb-0ee931cb0a97 admin-example <replaceable>(the new consumer UUID and the account used for registration)</replaceable></screen>
</example>
<note>
- <title>Tip</title>
+ <title>Using the --autosubscribe option</title>
<para>
The <command>register</command> command has an option, <option>--autosubscribe</option>, which allows the system to be registered to the subscription service and immediately subscribed to the subscription which best matches its architecture in a single step.
</para>
@@ -1021,7 +1020,7 @@
</table>
</section>
-
+
<section id="un-registering">
<title>Unregistering</title>
<indexterm>
@@ -1040,7 +1039,7 @@
The only thing required to unregister a machine is to run the <command>unregister</command> command. This removes the system's entry from the subscription service, unsubscribes it from any subscriptions, and, locally, deletes its identity and entitlement certificates.
</para>
<para>
- In the &OSORG; Subscription Manager GUI, there is an <guibutton>Unregister</guibutton> button at the top of the window in the <guilabel>Tools</guilabel> area.
+ In the Red Hat Subscription Manager GUI, there is an <guibutton>Unregister</guibutton> button at the top of the window in the <guilabel>Tools</guilabel> area.
</para>
<informalfigure> <mediaobject>
<imageobject>
@@ -1053,13 +1052,13 @@
</para>
<example id="ex.ents-unregister">
<title>Unregistering a Consumer</title>
-
+
<programlisting language="Bash">[root at server1 ~]# subscription-manager unregister</programlisting>
</example>
</section>
-
+
<section id="reregistering">
<title>Restoring a Registration</title>
<indexterm>
@@ -1078,7 +1077,7 @@
There are times when the local registration and subscription information could be lost or corrupted. There could be a hardware failure or system crash. Or other IT considerations may require that a system be moved to a different machine. Whatever the reason, the local subscription configuration is lost.
</para>
<para>
- A system can be registered against an existing system entry in the &OSORG; subscription service, which essentially restores or reregisters that consumer. The reregister operation uses the original consumer ID with the registration request, so that all of the previous subscriptions associated with the consumer entry are restored along with the registration.
+ A system can be registered against an existing system entry in the Red Hat subscription service, which essentially restores or reregisters that consumer. The reregister operation uses the original consumer ID with the registration request, so that all of the previous subscriptions associated with the consumer entry are restored along with the registration.
</para>
<para>
Reregistering a system uses the <command>register</command> command. This command passes the original UUID for a system to issue a request to the subscription service to receive a new certificate using the same UUID. This essentially renews its previous registration.
@@ -1088,7 +1087,7 @@
<para>
The <command>register</command> command uses the original ID to identify itself to the subscription service and restore its previous subscriptions.
</para>
-
+
<programlisting language="Bash">[root at server1 ~]# subscription-manager register --username admin-example --password secret --consumerid=7d133d55-876f-4f47-83eb-0ee931cb0a97</programlisting>
</example>
@@ -1116,7 +1115,7 @@
--consumerid
</entry>
<entry>
- Gives the consumer UUID used by an <emphasis>existing</emphasis> consumer. The system's consumer entry must exist in the &OSORG; subscription service for the reregister operation to succeed.
+ Gives the consumer UUID used by an <emphasis>existing</emphasis> consumer. The system's consumer entry must exist in the Red Hat subscription service for the reregister operation to succeed.
</entry>
<entry>
Required
@@ -1155,13 +1154,13 @@
</table>
</section>
-
+
</section>
<section id="activating-machine"><title>Activating a Machine</title>
<para>
- For some systems which were purchased through third-party vendors, a subscription to &OSORG; products is included with the purchase of the machine. &OSORG; Subscription Manager pulls information about the system hardware and the Bios into the system facts to recognize the hardware vendor. If the vendor and Bios information matches a certain configuration, then the machine can be <emphasis>activated</emphasis>, which will allow the system to be subscribed to the entitlements purchased with the machine.
+ For some systems which were purchased through third-party vendors, a subscription to Red Hat products is included with the purchase of the machine. Red Hat Subscription Manager pulls information about the system hardware and the Bios into the system facts to recognize the hardware vendor. If the vendor and Bios information matches a certain configuration, then the machine can be <emphasis>activated</emphasis>, which will allow the system to be subscribed to the entitlements purchased with the machine.
</para>
<para>
This diverges from the normal subscription process by adding an extra step:
@@ -1180,20 +1179,20 @@
<listitem>
<para>
The system is then subscribed to its subscriptions (<xref linkend="subscribing-ents" />).
- </para>
+ </para>
</listitem>
</orderedlist>
<section id="activating-gui"><title>Activating a Machine through the GUI</title>
- <note><title>Note</title>
+ <note><title>The Activate Subscription button</title>
<para>
- If the machine doesn't need to be activated, then the <guibutton>Activate Subscription</guibutton> button is not there.
+ If the machine does not need to be activated, then the <guibutton>Activate Subscription</guibutton> button is not there.
</para>
</note>
<orderedlist>
<listitem>
<para>
- Launch the &OSORG; Subscription Manager GUI. For example:
+ Launch the Red Hat Subscription Manager GUI. For example:
</para>
<screen>subscription-manager-gui</screen>
</listitem>
@@ -1228,7 +1227,7 @@
</listitem>
</orderedlist>
<para>
- It can take up to ten minutes for the confirmation email to arrive.
+ It can take up to ten minutes for the confirmation email to arrive.
</para>
</section>
<section id="activating-cli"><title>Activating a Machine through the Command Line</title>
@@ -1236,14 +1235,14 @@
The machine subscriptions are activated by running the <command>activate</command> command, with an email address to send the activation email to when the process is complete. For example:
</para>
<programlisting language="Bash"># subscription-manager activate --email=jsmith at example.com</programlisting>
- <note><title>Note</title>
+ <note><title>Register machines first</title>
<para>
The machine must be registered <emphasis>first</emphasis> so that the subscription service can properly identify the system and its subscriptions.
</para>
</note>
</section>
</section>
-
+
<section id="subscribing-ents">
<title>Handling Subscriptions</title>
<indexterm>
@@ -1259,7 +1258,7 @@
<secondary>handling subscriptions</secondary>
</indexterm>
<para>
- Assigning a <emphasis>subscription</emphasis> to a system gives the system the ability to install and update any &OSORG; product in that subscription. A subscription is a list of all of the products, in all variations, that were purchased at one time, and it defines both the products and the number of times that subscription can be used (the quantity of that product). The quantity is roughly the number of user licenses available. When one of those licenses if allocated to a system, that system is <emphasis>subscribed</emphasis> to the subscription.
+ Assigning a <emphasis>subscription</emphasis> to a system gives the system the ability to install and update any Red Hat product in that subscription. A subscription is a list of all of the products, in all variations, that were purchased at one time, and it defines both the products and the number of times that subscription can be used (the quantity of that product). The quantity is roughly the number of user licenses available. When one of those licenses if allocated to a system, that system is <emphasis>subscribed</emphasis> to the subscription.
</para>
<para>
A subscription is available to a system based on the system's architecture and other installed products. Subscriptions that are available for a platform (based on its hardware and operating system) are <emphasis>compatible</emphasis>. When the subscription is actually assigned to the machine, the subscription is <emphasis>consumed</emphasis>.
@@ -1271,7 +1270,7 @@
Unsubscribing a machine removes the entitlement to any of the products in the subscription, but the machine remains registered with the subscription service. Unsubscribing one system frees the subscription so that it can be allocated to another system.
</para>
<section id="sub-ui">
- <title>Subscribing and Unsubscribing through the &OSORG; Subscription Manager GUI</title>
+ <title>Subscribing and Unsubscribing through the Red Hat Subscription Manager GUI</title>
<section id="subscribing-product-ui">
<title>Subscribing to a Product</title>
<indexterm>
@@ -1292,9 +1291,9 @@
<orderedlist>
<listitem>
<para>
- Launch the &OSORG; Subscription Manager GUI. For example:
+ Launch the Red Hat Subscription Manager GUI. For example:
</para>
-
+
<screen>subscription-manager-gui</screen>
</listitem>
@@ -1357,9 +1356,9 @@
</listitem>
</orderedlist>
-
+
</section>
-
+
<section id="ADDING-SUB">
<title>Adding a New Subscription</title>
<indexterm>
@@ -1378,14 +1377,14 @@
<tertiary>uploading product certs</tertiary>
</indexterm>
<para>
- In certain situations, new product subscriptions can be added by uploading the X.509 entitlements certificate directly rather than polling the subscription service. This method is common for products purchased from &OSORG; directly.
+ In certain situations, new product subscriptions can be added by uploading the X.509 entitlements certificate directly rather than polling the subscription service. This method is common for products purchased from Red Hat directly.
</para>
<orderedlist>
<listitem>
<para>
- Launch the &OSORG; Subscription Manager GUI. For example:
+ Launch the Red Hat Subscription Manager GUI. For example:
</para>
-
+
<screen>subscription-manager-gui</screen>
</listitem>
@@ -1426,7 +1425,7 @@
</para>
</section>
-
+
<section id="unsubscribing-product-ui">
<title>Unsubscribing through the GUI</title>
<indexterm>
@@ -1447,9 +1446,9 @@
<orderedlist>
<listitem>
<para>
- Launch the &OSORG; Subscription Manager GUI. For example:
+ Launch the Red Hat Subscription Manager GUI. For example:
</para>
-
+
<screen>subscription-manager-gui</screen>
</listitem>
@@ -1484,10 +1483,10 @@
</orderedlist>
</section>
-
+
</section>
-
+
<section id="sub-cli">
<title>Handling Subscriptions through the subscription-manager</title>
<section id="subscribing-product-cmd">
@@ -1508,9 +1507,9 @@
<tertiary>from the command line</tertiary>
</indexterm>
<para>
- Subscribing a machine through the command line requires specifying the individual product or subscription to subscribe to, using the <option>--pool</option> option.
+ Subscribing a machine through the command line requires specifying the individual product or subscription to subscribe to, using the <option>--pool</option> option.
</para>
-
+
<programlisting language="Bash">[root at server1 ~]# subscription-manager subscribe --pool=XYZ01234567</programlisting>
<para>
The options for the <command>subscribe</command> command are listed in <xref linkend="tab.subscribe-options" />.
@@ -1526,9 +1525,9 @@
ProductName: RHEL for Physical Servers
-ProductId: MKT-rhel-server
-<userinput>PoolId:</userinput> <userinput>ff8080812bc382e3012bc3845ca000cb</userinput>
-Quantity: 10
+ProductId: MKT-rhel-server
+<userinput>PoolId:</userinput> <userinput>ff8080812bc382e3012bc3845ca000cb</userinput>
+Quantity: 10
Expires: 2011-09-20</programlisting>
<para>
Alternatively, the system can be subscribed to the best-fitting subscriptions, as identified by the subscription service, by using the <option>--auto</option> option (which is analogous to the <option>--autosubscribe</option> option with the <command>register</command> command).
@@ -1585,7 +1584,7 @@ Expires: 2011-09-20</programlisting>
</table>
</section>
-
+
<section id="unsubscribing-product-cmd">
<title>Unsubscribing from the subscription-manager</title>
<indexterm>
@@ -1609,7 +1608,7 @@ Expires: 2011-09-20</programlisting>
<para>
Running the <command>unsubscribe</command> command with the <option>--all</option> unsubscribes the system from every product and subscription pool it is currently subscribed to.
</para>
-
+
<programlisting language="Bash">[root at server1 ~]# subscription-manager unsubscribe --all</programlisting>
<para>
It is also possible to unsubscribe from a single product. Each product has an identifying X.509 certificate installed with it, and the product to unsubscribe from can be identified with the <command>unsubscribe</command> command to remove only that product subscription.
@@ -1619,7 +1618,7 @@ Expires: 2011-09-20</programlisting>
<para>
Get the serial number for the product certificate, if you are unsubscribing from a single product. The serial number can be obtained from the <filename>cert.pem</filename> file or by using the <command>list</command> command. For example:
</para>
-
+
<programlisting language="Bash">[root at server1 ~]# subscription-manager list --consumed
+-------------------------------------------+
@@ -1628,10 +1627,10 @@ Expires: 2011-09-20</programlisting>
ProductName: High availability (cluster suite)
-ContractNumber: 0
-SerialNumber: 11287514358600162
-Active: True
-Begins: 2010-09-18
+ContractNumber: 0
+SerialNumber: 11287514358600162
+Active: True
+Begins: 2010-09-18
Expires: 2011-11-18</programlisting>
</listitem>
@@ -1639,7 +1638,7 @@ Expires: 2011-11-18</programlisting>
<para>
Run the subscription-manager tool with the <option>--serial</option> option to specify the certificate.
</para>
-
+
<programlisting language="Bash">[root at server1 ~]# subscription-manager unsubscribe --serial=11287514358600162</programlisting>
</listitem>
@@ -1647,13 +1646,13 @@ Expires: 2011-11-18</programlisting>
</orderedlist>
</section>
-
+
</section>
-
+
</section>
-
+
<section id="viewing-ents">
<title>Viewing Available and Used Entitlements</title>
<para>
@@ -1677,10 +1676,10 @@ Expires: 2011-11-18</programlisting>
<tertiary>from the GUI</tertiary>
</indexterm>
<para>
- The &OSORG; Subscription Manager tools give a more detailed view of subscriptions and entitlements than is available through the global tools of the Customer Portal. Three tabs summarize each of the subscriptions and products for the specific machine: installed products (with subscriptions), subscribed entitlements, and available subscriptions.
+ The Red Hat Subscription Manager tools give a more detailed view of subscriptions and entitlements than is available through the global tools of the Customer Portal. Three tabs summarize each of the subscriptions and products for the specific machine: installed products (with subscriptions), subscribed entitlements, and available subscriptions.
</para>
<para>
- These summaries are always displayed in the &OSORG; Subscription Manager UI.
+ These summaries are always displayed in the Red Hat Subscription Manager UI.
</para>
<formalpara>
<title>Subscribed Entitlements</title>
@@ -1764,7 +1763,7 @@ Expires: 2011-11-18</programlisting>
</formalpara>
</section>
-
+
<section id="viewing-ents-cmd">
<title>Listing Entitlements with subscription-manager</title>
<indexterm>
@@ -1857,7 +1856,7 @@ Expires: 2011-11-18</programlisting>
<para>
The <command>list</command> command shows all of the subscriptions that are currently allocated to the system by using the <option>--consumed</option> option.
</para>
-
+
<programlisting language="Bash">[root at server1 ~]# subscription-manager list --consumed
+-------------------------------------------+
@@ -1866,15 +1865,15 @@ Expires: 2011-11-18</programlisting>
ProductName: Red Hat Enterprise Linux Server
-ContractNumber: 1458961
-SerialNumber: 171286550006020205
-Active: True
-Begins: 2009-01-01
+ContractNumber: 1458961
+SerialNumber: 171286550006020205
+Active: True
+Begins: 2009-01-01
Expires: 2011-12-31</programlisting>
<para>
The <command>list</command> command shows all of the subscriptions that are compatible with and available to the system using the <option>--available</option> option. To include every subscription the organization has — both the ones that are compatible with the system and others for other platforms — use the <option>--all</option> option with the <option>--available</option>. The <option>--ondate</option> option shows only subscriptions which are active on that date, based on their activation and expiry dates.
</para>
-
+
<programlisting language="Bash">[root at server1 ~]# subscription-manager list --available --all
+-------------------------------------------+
@@ -1883,17 +1882,17 @@ Expires: 2011-12-31</programlisting>
ProductName: RHEL for Physical Servers
-ProductId: MKT-rhel-server
+ProductId: MKT-rhel-server
PoolId: ff8080812bc382e3012bc3845ca000cb
-Quantity: 10
-Expires: 2011-09-20
+Quantity: 10
+Expires: 2011-09-20
-ProductName: RHEL Workstation
-ProductId: MKT-rhel-workstation-mkt
-PoolId: 5e09a31f95885cc4
-Quantity: 10
-Expires: 2011-09-20
+ProductName: RHEL Workstation
+ProductId: MKT-rhel-workstation-mkt
+PoolId: 5e09a31f95885cc4
+Quantity: 10
+Expires: 2011-09-20
[snip]</programlisting>
@@ -1906,24 +1905,24 @@ Expires: 2011-09-20
Installed Product Status
+-------------------------------------------+
ProductName: Red Hat Enterprise Linux Entitlement
-Status: Not Subscribed
-Expires:
-Subscription:
-ContractNumber:
-AccountNumber:
-
-
-ProductName: Awesome OS Server
-Status: Not Installed
-Expires: 2012-02-20
-Subscription: 54129829316535230
-ContractNumber: 39
+Status: Not Subscribed
+Expires:
+Subscription:
+ContractNumber:
+AccountNumber:
+
+
+ProductName: Awesome OS Server
+Status: Not Installed
+Expires: 2012-02-20
+Subscription: 54129829316535230
+ContractNumber: 39
AccountNumber: 12331131231</programlisting>
</section>
-
+
</section>
-
+
<section id="responding-to-nags-ui">
<title>Responding to Subscription Notifications</title>
<indexterm>
@@ -1939,7 +1938,7 @@ AccountNumber: 12331131231</programlisting>
<secondary>notifications</secondary>
</indexterm>
<para>
- The &OSORG; Subscription Manager provides a series of log and UI messages that indicate any changes to the valid certificates of any installed products for a system. Whenever there is a warning about subscription changes, a small icon appears in the top menu bar, similar to a fuel gauge.
+ The Red Hat Subscription Manager provides a series of log and UI messages that indicate any changes to the valid certificates of any installed products for a system. Whenever there is a warning about subscription changes, a small icon appears in the top menu bar, similar to a fuel gauge.
</para>
<figure id="fig.ents-nag">
<title>Subscription Notification Icon</title>
@@ -1952,7 +1951,7 @@ AccountNumber: 12331131231</programlisting>
</figure>
<para>
- As any installed product nears the expiration date of the subscription, the Subscription Manager daemon will issue a warning. A similar message is given when the system is has products without a valid certificate, meaning either the system is not subscribed to a subscription that entitles that product or the product is installed past the expiration of the subscription. Clicking the <guilabel>Manage My Subscriptions...</guilabel> button in the subscription notification window opens the &OSORG; Subscription Manager GUI to view and update subscriptions.
+ As any installed product nears the expiration date of the subscription, the Subscription Manager daemon will issue a warning. A similar message is given when the system is has products without a valid certificate, meaning either the system is not subscribed to a subscription that entitles that product or the product is installed past the expiration of the subscription. Clicking the <guilabel>Manage My Subscriptions...</guilabel> button in the subscription notification window opens the Red Hat Subscription Manager GUI to view and update subscriptions.
</para>
<figure id="fig.ents-nag-warning">
<title>Entitlements Warning Message</title>
@@ -1976,7 +1975,7 @@ AccountNumber: 12331131231</programlisting>
</mediaobject>
</figure>
<para>
- The Subscription Assistant pop-up window shows a targeted list of available subscriptions that apply to the specific products that do not have valid certificates (assuming subscriptions are available).
+ The Subscription Assistant pop-up window shows a targeted list of available subscriptions that apply to the specific products that do not have valid certificates (assuming subscriptions are available).
</para>
<figure id="fig.rhsm-compliance1">
<title>Subscription Assistant</title>
@@ -2006,7 +2005,7 @@ AccountNumber: 12331131231</programlisting>
</itemizedlist>
</section>
-
+
<section id="uploading-new-certs">
<title>Updating Entitlements Certificates</title>
<indexterm>
@@ -2028,7 +2027,7 @@ AccountNumber: 12331131231</programlisting>
The entitlement certificate is an X.509 certificate and is stored in a base 64-encoded blob in a <filename>.pem</filename> file.
</para>
<para>
- When a subscription expires or is changed, then the entitlement certificate must be updated to account for the changes. The &OSORG; Subscription Manager polls the subscription service periodically to check for updated entitlement certificates; this can also be updated immediately or pulled down from the Customer Portal. The entitlement certificates are updated by revoking the previous entitlement certificate and generating a new one to replace it.
+ When a subscription expires or is changed, then the entitlement certificate must be updated to account for the changes. The Red Hat Subscription Manager polls the subscription service periodically to check for updated entitlement certificates; this can also be updated immediately or pulled down from the Customer Portal. The entitlement certificates are updated by revoking the previous entitlement certificate and generating a new one to replace it.
</para>
<section id="regen-certs-ui"><title>Regenering Entitlement Certificates in the GUI</title>
@@ -2038,9 +2037,9 @@ AccountNumber: 12331131231</programlisting>
<orderedlist>
<listitem>
<para>
- Open the &OSORG; Customer Portal.
+ Open the Red Hat Customer Portal.
</para>
-
+
<screen>https://access.redhat.com/</screen>
</listitem>
@@ -2058,7 +2057,7 @@ AccountNumber: 12331131231</programlisting>
<imageobject>
<imagedata fileref="images/ents-global-subscr.png" />
</imageobject>
-
+
</mediaobject>
</informalfigure>
</listitem>
@@ -2070,26 +2069,26 @@ AccountNumber: 12331131231</programlisting>
<para>
To update the entitlement certificates from the Subscription Manager CLI, use the <command>refresh</command> command:
</para>
-
+
<screen>[root at server1 ~]# subscription-manager refresh</screen>
<para>
To regenerate the entitlement certificate (meaning it is revoked and replaced), use the <command>identity</command> command. Although not required, using the <option>--force</option> option will require the username and password and will cause the Subscription Manager to prompt for the credentials if they are not passed in the command:
</para>
<programlisting language="Bash">[root at server1 ~]# subscription-manager identity --force
Username: jsmith
-Password:
+Password:
eff9a4c9-3579-49e5-a52f-83f2db29ab52 server.example.com</programlisting>
</section>
</section>
-
+
<section id="rhsm-config">
<title>Configuring the Subscription Service</title>
<para>
- By default, &OSORG; Subscription Manager (both GUI and CLI) talk to the subscription service and the Customer Portal for their subscription services and content delivery, respectively. &OSORG; Subscription Manager can be configured to use different content servers or subscription services. Other aspects of the &OSORG; Subscription Manager — like the locations to look for system and product certificates or the system information used by &OSORG; Subscription Manager to identify compatible entitlements — can also be customized to fit the network environment.
+ By default, Red Hat Subscription Manager (both GUI and CLI) talk to the subscription service and the Customer Portal for their subscription services and content delivery, respectively. Red Hat Subscription Manager can be configured to use different content servers or subscription services. Other aspects of the Red Hat Subscription Manager — like the locations to look for system and product certificates or the system information used by Red Hat Subscription Manager to identify compatible entitlements — can also be customized to fit the network environment.
</para>
<section id="rhsm-files">
- <title>&OSORG; Subscription Manager Configuration Files</title>
+ <title>Red Hat Subscription Manager Configuration Files</title>
<indexterm>
<primary>entitlements</primary>
<secondary>configuration</secondary>
@@ -2106,15 +2105,15 @@ eff9a4c9-3579-49e5-a52f-83f2db29ab52 server.example.com</programlisting>
<tertiary>files</tertiary>
</indexterm>
<para>
- The primary configuration file for &OSORG; Subscription Manager, both the GUI and CLI tools, is the <filename>rhsm.conf</filename> configuration file. There are other support files that either influence the &OSORG; Subscription Manager service or can help administrators better use the Subscription Manager.
+ The primary configuration file for Red Hat Subscription Manager, both the GUI and CLI tools, is the <filename>rhsm.conf</filename> configuration file. There are other support files that either influence the Red Hat Subscription Manager service or can help administrators better use the Subscription Manager.
</para>
<section id="all-rhsm-files">
- <title>All Files Used by &OSORG; Subscription Manager</title>
+ <title>All Files Used by Red Hat Subscription Manager</title>
<para>
- All of the files related to the configuration of &OSORG; Subscription Manager are used by both the GUI and CLI; there's no separate configuration.
+ All of the files related to the configuration of Red Hat Subscription Manager are used by both the GUI and CLI; there's no separate configuration.
</para>
<table id="tab.all-rhsm-files">
- <title>&OSORG; Subscription Manager Files and Directories</title>
+ <title>Red Hat Subscription Manager Files and Directories</title>
<tgroup cols="2">
<thead>
<row>
@@ -2134,7 +2133,7 @@ eff9a4c9-3579-49e5-a52f-83f2db29ab52 server.example.com</programlisting>
/etc/rhsm
</entry>
<entry>
- The primary &OSORG; Subscription Manager configuration directory.
+ The primary Red Hat Subscription Manager configuration directory.
</entry>
</row>
@@ -2143,7 +2142,7 @@ eff9a4c9-3579-49e5-a52f-83f2db29ab52 server.example.com</programlisting>
/etc/rhsm/rhsm.conf
</entry>
<entry>
- The &OSORG; Subscription Manager configuration file. This is used by both the GUI and the CLI.
+ The Red Hat Subscription Manager configuration file. This is used by both the GUI and the CLI.
</entry>
</row>
@@ -2170,7 +2169,7 @@ eff9a4c9-3579-49e5-a52f-83f2db29ab52 server.example.com</programlisting>
/var/log/rhsm
</entry>
<entry>
- The &OSORG; Subscription Manager log directory.
+ The Red Hat Subscription Manager log directory.
</entry>
</row>
@@ -2179,7 +2178,7 @@ eff9a4c9-3579-49e5-a52f-83f2db29ab52 server.example.com</programlisting>
/var/log/rhsm/rhsm.log
</entry>
<entry>
- The log for the &OSORG; Subscription Manager tools.
+ The log for the Red Hat Subscription Manager tools.
</entry>
</row>
@@ -2188,7 +2187,7 @@ eff9a4c9-3579-49e5-a52f-83f2db29ab52 server.example.com</programlisting>
/var/log/rhsm/rhsmcertd.log
</entry>
<entry>
- The log for the &OSORG; Subscription Manager daemon, <command>rhsmcertd</command>.
+ The log for the Red Hat Subscription Manager daemon, <command>rhsmcertd</command>.
</entry>
</row>
@@ -2242,7 +2241,7 @@ eff9a4c9-3579-49e5-a52f-83f2db29ab52 server.example.com</programlisting>
/var/run/subsys/rhsm
</entry>
<entry>
- Runtime files for &OSORG; Subscription Manager
+ Runtime files for Red Hat Subscription Manager
</entry>
</row>
@@ -2269,7 +2268,7 @@ eff9a4c9-3579-49e5-a52f-83f2db29ab52 server.example.com</programlisting>
/etc/yum/pluginconf.d/rhsmplugin.conf
</entry>
<entry>
- The configuration file to include the &OSORG; Subscription Manager plug-in in the <command>yum</command> configuration.
+ The configuration file to include the Red Hat Subscription Manager plug-in in the <command>yum</command> configuration.
</entry>
</row>
@@ -2278,7 +2277,7 @@ eff9a4c9-3579-49e5-a52f-83f2db29ab52 server.example.com</programlisting>
/usr/share/rhsm
</entry>
<entry>
- All of the Python and script files used by both &OSORG; Subscription Manager tool to perform subscription tasks.
+ All of the Python and script files used by both Red Hat Subscription Manager tool to perform subscription tasks.
</entry>
</row>
@@ -2287,7 +2286,7 @@ eff9a4c9-3579-49e5-a52f-83f2db29ab52 server.example.com</programlisting>
/usr/share/rhsm/gui
</entry>
<entry>
- All of the Python script and image files used to render the &OSORG; Subscription Manager GUI.
+ All of the Python script and image files used to render the Red Hat Subscription Manager GUI.
</entry>
</row>
@@ -2299,7 +2298,7 @@ eff9a4c9-3579-49e5-a52f-83f2db29ab52 server.example.com</programlisting>
</table>
</section>
-
+
<section id="rhsm.conf">
<title>About the rhsm.conf File</title>
<indexterm>
@@ -2318,7 +2317,7 @@ eff9a4c9-3579-49e5-a52f-83f2db29ab52 server.example.com</programlisting>
<tertiary>rhsm.conf</tertiary>
</indexterm>
<para>
- The main configuration file for the Subscription Manager is <filename>rhsm.conf</filename>. This file configures several important aspects of how &OSORG; Subscription Manager interacts with both entitlements and content services:
+ The main configuration file for the Subscription Manager is <filename>rhsm.conf</filename>. This file configures several important aspects of how Red Hat Subscription Manager interacts with both entitlements and content services:
</para>
<itemizedlist>
<listitem>
@@ -2346,7 +2345,7 @@ eff9a4c9-3579-49e5-a52f-83f2db29ab52 server.example.com</programlisting>
</para>
<example id="ex.rhsm.conf">
<title>Default rhsm.conf File</title>
-
+
<programlisting language="Bash"># Red Hat Subscription Manager Configuration File:
# Unified Entitlement Platform Configuration
@@ -2374,7 +2373,7 @@ ca_cert_dir = /etc/rhsm/ca/
proxy_hostname =
# port for http proxy server
-proxy_port =
+proxy_port =
# user name for authenticating to an http proxy, if needed
proxy_user =
@@ -2494,7 +2493,7 @@ certFrequency = 240</programlisting>
Gives the hostname of the proxy server. This is required.
</entry>
<entry>
-
+
</entry>
</row>
<row>
@@ -2505,7 +2504,7 @@ certFrequency = 240</programlisting>
Gives the port of the proxy server. This is required.
</entry>
<entry>
-
+
</entry>
</row>
<row>
@@ -2516,7 +2515,7 @@ certFrequency = 240</programlisting>
Gives the user account to use to access the proxy server. This may not be required, depending on the proxy server configuration.
</entry>
<entry>
-
+
</entry>
</row>
<row>
@@ -2527,7 +2526,7 @@ certFrequency = 240</programlisting>
Gives the password credentials to access the proxy server. This may not be required, depending on the proxy server configuration.
</entry>
<entry>
-
+
</entry>
</row>
<row>
@@ -2651,12 +2650,12 @@ certFrequency = 240</programlisting>
</table>
</section>
-
+
</section>
- <!--
+ <!--
<section id="setting-up-rhsm-mirror">
- <title>Configuring &OSORG; Subscription Manager to Use a Content Mirror</title>
+ <title>Configuring Red Hat Subscription Manager to Use a Content Mirror</title>
<indexterm>
<primary>entitlements</primary>
<secondary>configuration</secondary>
@@ -2673,14 +2672,14 @@ certFrequency = 240</programlisting>
<tertiary>content mirrors</tertiary>
</indexterm>
<para>
- By default, the Subscription Manager is configured to use &OSORG;'s content delivery service, which is available at <ulink url="http://redhat.com/content" />. This can be changed to use a different external content delivery system or to use an organization-managed Satellite 5.x system.
+ By default, the Subscription Manager is configured to use Red Hat's content delivery service, which is available at <ulink url="http://redhat.com/content" />. This can be changed to use a different external content delivery system or to use an organization-managed Satellite 5.x system.
</para>
<orderedlist>
<listitem>
<para>
Open the Subscription Manager configuration file.
</para>
-
+
<programlisting language="Bash">vim /etc/rhsm/rhsm.conf</programlisting>
</listitem>
@@ -2688,7 +2687,7 @@ certFrequency = 240</programlisting>
<para>
Change the <parameter>baseurl</parameter> directive in the <command>[rhsm]</command> section. This is the full URL to the service.
</para>
-
+
<programlisting language="Bash">[rhsm]
# Content base URL:
baseurl= http://cotent.example.com/content-satellite</programlisting>
@@ -2699,7 +2698,7 @@ baseurl= http://cotent.example.com/content-satellite</programlisting>
</section>
-->
-
+
<section id="rhsm-http-proxy">
<title>Using an HTTP Proxy</title>
<para>
@@ -2723,14 +2722,14 @@ baseurl= http://cotent.example.com/content-satellite</programlisting>
<tertiary>HTTP proxy (GUI)</tertiary>
</indexterm>
<para>
- The &OSORG; Subscription Manager GUI can be configured to use an HTTP proxy for all of its connections to the subscription service. (This is also an advanced configuration option at firstboot.) To configure the proxy:
+ The Red Hat Subscription Manager GUI can be configured to use an HTTP proxy for all of its connections to the subscription service. (This is also an advanced configuration option at firstboot.) To configure the proxy:
</para>
<orderedlist>
<listitem>
<para>
- Launch the &OSORG; Subscription Manager GUI. For example:
+ Launch the Red Hat Subscription Manager GUI. For example:
</para>
-
+
<screen>subscription-manager-gui</screen>
</listitem>
@@ -2748,7 +2747,7 @@ baseurl= http://cotent.example.com/content-satellite</programlisting>
</listitem>
<listitem>
<para>
- Check the <guilabel>...Connect to &OSORG; Network via an HTTP Proxy</guilabel> checkbox and enter the server location, in the format <emphasis>hostname:port</emphasis>.
+ Check the <guilabel>...Connect to Red Hat Network via an HTTP Proxy</guilabel> checkbox and enter the server location, in the format <emphasis>hostname:port</emphasis>.
</para>
<informalfigure> <mediaobject>
<imageobject>
@@ -2806,7 +2805,7 @@ baseurl= http://cotent.example.com/content-satellite</programlisting>
<para>
Change the settings in the <command>[server]</command> section that relate to the HTTP proxy. All parameters are described in <xref linkend="tab.rhsm.conf-parameters" />. There are four parameters directly related to the proxy:
</para>
-
+
<itemizedlist>
<listitem>
<para>
@@ -2829,14 +2828,14 @@ baseurl= http://cotent.example.com/content-satellite</programlisting>
<parameter>proxy_user</parameter> for the user account to connect to the proxy; this may not be required, depending on the proxy server's configuration.
</para>
</listitem>
-
+
<listitem>
<para>
<parameter>proxy_password</parameter> for the password for the user account to connect to the proxy; this may not be required, depending on the proxy server's configuration.
</para>
</listitem>
</itemizedlist>
-
+
<programlisting language="Bash">[server]
# an http proxy server to use
@@ -2855,7 +2854,7 @@ proxy_password =</programlisting>
</orderedlist>
</section>
-
+
<section id="ents-proxycmd">
<title>Passing HTTP Proxy Information with subscription-manager Commands</title>
<indexterm>
@@ -2942,14 +2941,14 @@ proxy_password =</programlisting>
<para>
The proxy information can be passed with any <command>subscription-manager</command> operation. For example:
</para>
-
+
<programlisting>[root at server1 ~]# subscription-manager subscribe --pool=ff8080812bc382e3012bc3845ca000cb --proxy=proxy.example.com:8443 --proxyuser=jsmith --proxypass=secret</programlisting>
</section>
-
+
</section>
-
+
<section id="changing-ents-server">
<title>Changing the Subscription Server</title>
<indexterm>
@@ -2968,7 +2967,7 @@ proxy_password =</programlisting>
<tertiary>changing subscription service</tertiary>
</indexterm>
<para>
- The Subscription Manager usually connects to the subscription service, and the public server is configured in the <filename>rhsm.conf</filename> file.
+ The Subscription Manager usually connects to the subscription service, and the public server is configured in the <filename>rhsm.conf</filename> file.
<!-- There may be instances when an organization is running a mirror, an internal subscription service, or some other subscription service. -->
The subscription service connection settings are in the <command>[server]</command> section of the configuration file.
</para>
@@ -2977,7 +2976,7 @@ proxy_password =</programlisting>
<para>
Open the Subscription Manager configuration file.
</para>
-
+
<programlisting language="Bash">vim /etc/rhsm/rhsm.conf</programlisting>
</listitem>
@@ -3006,7 +3005,7 @@ proxy_password =</programlisting>
</listitem>
</itemizedlist>
-
+
<programlisting language="Bash">[server]
hostname=entitlements.server.example.com
prefix=/candlepin
@@ -3017,7 +3016,7 @@ port=8443</programlisting>
</orderedlist>
</section>
-
+
<section id="secure-cxn-ents-server">
<title>Managing Secure Connections to the Subscription Server</title>
<indexterm>
@@ -3036,14 +3035,14 @@ port=8443</programlisting>
<tertiary>SSL</tertiary>
</indexterm>
<para>
- &OSORG; Subscription Manager assumes, by default, that the subscription clients connect to the subscription service using a secure (SSL) connection. This requires that the CA certificate of the subscription service be downloaded and available locally for the client and that the appropriate connections be configured.
+ Red Hat Subscription Manager assumes, by default, that the subscription clients connect to the subscription service using a secure (SSL) connection. This requires that the CA certificate of the subscription service be downloaded and available locally for the client and that the appropriate connections be configured.
</para>
<orderedlist>
<listitem>
<para>
Open the Subscription Manager configuration file.
</para>
-
+
<programlisting language="Bash">vim /etc/rhsm/rhsm.conf</programlisting>
</listitem>
@@ -3072,7 +3071,7 @@ port=8443</programlisting>
</listitem>
</itemizedlist>
-
+
<programlisting language="Bash">[server]
port=8443
insecure = 1
@@ -3083,7 +3082,7 @@ ca_cert = /etc/rhsm/ca</programlisting>
</orderedlist>
</section>
-
+
<section id="starting-rhsm">
<title>Starting and Stopping the Subscription Service</title>
<indexterm>
@@ -3099,26 +3098,26 @@ ca_cert = /etc/rhsm/ca</programlisting>
<secondary>stopping/starting service</secondary>
</indexterm>
<para>
- The &OSORG; Subscription Manager daemon, <systemitem>rhsmcertd</systemitem>, runs as a service on the system. The daemon, by default, starts with the system, and it can be started, stopped, or checked with the <command>service</command> command.
+ The Red Hat Subscription Manager daemon, <systemitem>rhsmcertd</systemitem>, runs as a service on the system. The daemon, by default, starts with the system, and it can be started, stopped, or checked with the <command>service</command> command.
</para>
-
+
<programlisting language="Bash">service rhsmcertd status
rhsmcertd (pid 13084) is running...</programlisting>
<para>
&MAJOROS; has a tool called <emphasis>chkconfig</emphasis> which manages the automatic startup and shutdown settings for each process on the server, described in <xref linkend="s2-services-chkconfig" />. When a system reboots, some services can be automatically restarted. <command>chkconfig</command> also defines startup settings for different run levels of the server.
</para>
<para>
- The &OSORG; Subscription Manager service, which runs routinely to check for changes in the entitlements for an organization, can be controlled by <command>chkconfig</command>. By default, the &OSORG; Subscription Manager daemon, <systemitem>rhsmcertd</systemitem>, is configured to run at levels 3, 4, and 5, so that the service is started automatically when the server reboots.
+ The Red Hat Subscription Manager service, which runs routinely to check for changes in the entitlements for an organization, can be controlled by <command>chkconfig</command>. By default, the Red Hat Subscription Manager daemon, <systemitem>rhsmcertd</systemitem>, is configured to run at levels 3, 4, and 5, so that the service is started automatically when the server reboots.
</para>
<para>
The run level settings can be reset using <command>chkconfig</command>. For example, to enable run level 2:
</para>
-
+
<screen>chkconfig --level 2345 rhsmcertd on</screen>
<para>
To remove the <systemitem>rhsmcertd</systemitem> from the start list, change the run level settings off:
</para>
-
+
<screen>chkconfig --level 2345 rhsmcertd off</screen>
<para>
&MAJOROS; also has a GUI console that can manage the <command>service</command> and <command>chkconfig</command> settings.
@@ -3135,11 +3134,10 @@ rhsmcertd (pid 13084) is running...</programlisting>
Open the <guimenu>Services</guimenu> link.
</para>
<note>
- <title>Note</title>
+ <title>The Services wizard depends on system-config-services</title>
<para>
The <filename>system-config-services</filename> package must be installed for the <guimenu>Services</guimenu> wizard to be available.
</para>
-
</note>
<informalfigure> <mediaobject>
<imageobject>
@@ -3165,7 +3163,7 @@ rhsmcertd (pid 13084) is running...</programlisting>
</orderedlist>
</section>
-
+
<section id="checking-rhsm-logs">
<title>Checking Logs</title>
<indexterm>
@@ -3185,7 +3183,7 @@ rhsmcertd (pid 13084) is running...</programlisting>
<secondary>logs</secondary>
</indexterm>
<para>
- There are two log files maintained for &OSORG; Subscription Manager in the <filename>/var/log/rhsm</filename> directory:
+ There are two log files maintained for Red Hat Subscription Manager in the <filename>/var/log/rhsm</filename> directory:
</para>
<itemizedlist>
<listitem>
@@ -3205,7 +3203,7 @@ rhsmcertd (pid 13084) is running...</programlisting>
<para>
The <filename>rhsm.log</filename> log contains the sequence of every Python call for every operation invoked through the Subscription Manager tools. Each entry has this format:
</para>
-
+
<screen>YYYY-MM-DD HH:MM:SS,process_id [MESSAGE_TYPE] call python_script response</screen>
<para>
The <emphasis>response</emphasis> in the log entry can be very complex, spanning multiple lines, or relatively simply, with just a status code.
@@ -3215,7 +3213,7 @@ rhsmcertd (pid 13084) is running...</programlisting>
</para>
<example id="ex.rhsm.log">
<title>rhsm.log Entry</title>
-
+
<programlisting language="Python">2010-10-01 17:27:57,874 [INFO] _request() @connection.py:97 - status code: 200
2010-10-01 17:27:57,875 [INFO] perform() @certlib.py:132 - updated:
Total updates: 0
@@ -3238,14 +3236,14 @@ Expired (deleted):
</para>
<example id="ex.rhsmcertd.log">
<title>rhsmcertd.log Entry</title>
-
+
<programlisting>Fri Oct 1 13:27:44 2010: started: interval = 240 minutes
Fri Oct 1 13:27:50 2010: certificates updated</programlisting>
</example>
</section>
-
+
<section id="showing-incompatible-subsc">
<title>Showing and Hiding Incompatible Subscriptions</title>
<indexterm>
@@ -3264,12 +3262,12 @@ Fri Oct 1 13:27:50 2010: certificates updated</programlisting>
<tertiary>showing incompatible subscriptions</tertiary>
</indexterm>
<para>
- The entitlements that are made available to a consumer are filtered, by default, according to whether the architecture for the product matches the architecture of the system. This is <emphasis>compatibility</emphasis>. The &OSORG; Subscription Manager can be configured to display even incompatible entitlements.
+ The entitlements that are made available to a consumer are filtered, by default, according to whether the architecture for the product matches the architecture of the system. This is <emphasis>compatibility</emphasis>. The Red Hat Subscription Manager can be configured to display even incompatible entitlements.
</para>
<para>
When running the command-line tools, the incompatible facts can be displayed simply by using the <option>--all</option> option:
</para>
-
+
<screen>[root at server1 ~]# subscription-manager list --available --all</screen>
<para>
To have the incompatible subscriptions displayed in the GUI and through the command-line by default, edit the <filename>rhsm.conf</filename> configuration file.
@@ -3279,7 +3277,7 @@ Fri Oct 1 13:27:50 2010: certificates updated</programlisting>
<para>
Open the Subscription Manager configuration file.
</para>
-
+
<programlisting language="Bash">vim /etc/rhsm/rhsm.conf</programlisting>
</listitem>
@@ -3287,7 +3285,7 @@ Fri Oct 1 13:27:50 2010: certificates updated</programlisting>
<para>
Change the <parameter>showIncompatiblePools</parameter> directive in the <command>[rhsm]</command> section. A value of <command>0</command> shows only compatible entitlements.
</para>
-
+
<programlisting language="Bash">[rhsm]
# Content base URL:
showIncompatiblePools = 1</programlisting>
@@ -3297,7 +3295,7 @@ showIncompatiblePools = 1</programlisting>
</orderedlist>
</section>
-
+
<section id="rhsm-facts">
<title>Checking and Adding System Facts</title>
<indexterm>
@@ -3313,23 +3311,23 @@ showIncompatiblePools = 1</programlisting>
<secondary>facts</secondary>
</indexterm>
<para>
- Entitlements are available to a system based on whether the software is <emphasis>compatible</emphasis> with the system's architecture. For example, there are different products and subscriptions for 32-bit and 64-bit platforms. &OSORG; Subscription Manager determines compatibility by collecting a range of facts about the system's hardware and architecture and then comparing it with all available entitlements.
+ Entitlements are available to a system based on whether the software is <emphasis>compatible</emphasis> with the system's architecture. For example, there are different products and subscriptions for 32-bit and 64-bit platforms. Red Hat Subscription Manager determines compatibility by collecting a range of facts about the system's hardware and architecture and then comparing it with all available entitlements.
</para>
<para>
The collected facts can be viewed, updated to acknowledge a hardware or configuration change, or overridden to force compatibility in the specified areas.
</para>
<para>
- The system facts are very similar to the information in <filename>/etc/redhat-release</filename> or <filename>/etc/sysconfig</filename>. In both the &OSORG; Subscription Manager GUI and CLI, the facts are represented as simple <emphasis>attribute: value</emphasis> pairs.
+ The system facts are very similar to the information in <filename>/etc/redhat-release</filename> or <filename>/etc/sysconfig</filename>. In both the Red Hat Subscription Manager GUI and CLI, the facts are represented as simple <emphasis>attribute: value</emphasis> pairs.
</para>
<note>
- <title>Tip</title>
+ <title>Updating the facts</title>
<para>
- Updating the facts resends the information about the system to the &OSORG; subscription service so that it can update the list of subscriptions which match the system architecture. Updating the facts is a very good thing to do after hardware upgrades or other important system changes.
+ Updating the facts resends the information about the system to the Red Hat subscription service so that it can update the list of subscriptions which match the system architecture. Updating the facts is a very good thing to do after hardware upgrades or other important system changes.
</para>
</note>
<section id="rhsm-facts-gui">
- <title>Checking Facts from the &OSORG; Subscription Manager UI</title>
+ <title>Checking Facts from the Red Hat Subscription Manager UI</title>
<indexterm>
<primary>entitlements</primary>
<secondary>configuration</secondary>
@@ -3348,9 +3346,9 @@ showIncompatiblePools = 1</programlisting>
<orderedlist>
<listitem>
<para>
- Launch the &OSORG; Subscription Manager GUI. For example:
+ Launch the Red Hat Subscription Manager GUI. For example:
</para>
-
+
<screen>subscription-manager-gui</screen>
</listitem>
@@ -3385,7 +3383,7 @@ showIncompatiblePools = 1</programlisting>
</orderedlist>
</section>
-
+
<section id="rhsm-facts-cmd">
<title>Checking Facts with subscription-manager</title>
<indexterm>
@@ -3406,7 +3404,7 @@ showIncompatiblePools = 1</programlisting>
<para>
To simply list the facts, run the <command>facts</command> with the <option>--list</option> option.
</para>
-
+
<programlisting language="Bash">[root at server1 ~]# subscription-manager facts --list
cpu.architecture: i686
@@ -3433,11 +3431,11 @@ dmi.baseboard.product_name: Server Blade
<para>
To update the facts after a system change, use the <option>--update</option> option with the <command>facts</command> command.
</para>
-
+
<programlisting language="Bash">[root at server1 ~]# subscription-manager facts --update</programlisting>
</section>
-
+
<section id="rhsm-facts-overriding">
<title>Overriding the Default System Facts</title>
<indexterm>
@@ -3458,14 +3456,14 @@ dmi.baseboard.product_name: Server Blade
<para>
The system facts, as collected, are stored in <filename>/var/lib/rhsm/facts/facts.facts</filename>. These facts are stored as <emphasis>attribute: value</emphasis> pairs, in a comma-separated list.
</para>
-
+
<programlisting>{"fact1": "value1","fact2": "value2"}</programlisting>
<para>
The primary file is generated and maintained by the Subscription Manager service. However, these values can be overridden to force architecture or platform compatibility (and thereby widening the available compatible subscriptions) by creating additional JSON facts files and dropping them in the <filename>/etc/rhsm/facts</filename> directory. These JSON files can override existing facts or even add new facts to be used by the subscription service.
</para>
<example id="ex.facts-file">
<title>Example Facts Override File</title>
-
+
<programlisting language="Java">vim /etc/rhsm/facts/my-example.facts
{"uname.machine": "x86","kernel_version": "2.6.32","physical_location": "MTV colo rack 5"}</programlisting>
@@ -3473,10 +3471,10 @@ dmi.baseboard.product_name: Server Blade
</example>
</section>
-
+
</section>
-
+
<section id="getting-system-uuid">
<title>Getting the System UUID</title>
<indexterm>
@@ -3503,13 +3501,13 @@ dmi.baseboard.product_name: Server Blade
</informalfigure> <para>
From the command-line, use the <command>identity</command> command to return the current UUID.
</para>
-
+
<screen>[root at server1 ~]# subscription-manager identity
7d133d55 876f 4f47 83eb 0ee931cb0a97 <replaceable>account name</replaceable></screen>
</section>
-
+
<section id="consumerid">
<title>Retrieving the Consumer ID, Registration Tokens, and Other Information</title>
<indexterm>
@@ -3521,7 +3519,7 @@ dmi.baseboard.product_name: Server Blade
<secondary>finding information</secondary>
</indexterm>
<para>
- Some pieces of information are used frequently when managing entitlements using the <command>subscription-manager</command> script. Information like the consumer ID or subscription pool ID is pulled up and referenced automatically in the &OSORG; Subscription Manager UI, but it has to be entered manually in the command line.
+ Some pieces of information are used frequently when managing entitlements using the <command>subscription-manager</command> script. Information like the consumer ID or subscription pool ID is pulled up and referenced automatically in the Red Hat Subscription Manager UI, but it has to be entered manually in the command line.
</para>
<para>
<xref linkend="tab.ents-information" /> lists common information that is used to manage subscriptions, the operations they're used in, and the places to find the data.
@@ -3559,14 +3557,14 @@ dmi.baseboard.product_name: Server Blade
identity
</entry>
<entry>
- The simplest method is to use the <command>identity</command> command to return the current UUID.
+ The simplest method is to use the <command>identity</command> command to return the current UUID.
<screen>[root at server1 ~]# subscription-manager identity
7d133d55 876f 4f47 83eb 0ee931cb0a97 <replaceable>account name</replaceable></screen>
- The Subject CN element of the identity certificate for the system, <filename>/etc/pki/consumer/cert.pem</filename>. The UUID can also be returned by using <command>openssl</command> to pretty-print the certificate.
+ The Subject CN element of the identity certificate for the system, <filename>/etc/pki/consumer/cert.pem</filename>. The UUID can also be returned by using <command>openssl</command> to pretty-print the certificate.
<screen>openssl x509 -text -in /etc/pki/consumer/cert.pem
-Certificate:
+Certificate:
... snip ...
Subject: CN=7d133d55 876f 4f47 83eb 0ee931cb0a97</screen>
@@ -3584,15 +3582,15 @@ Subject: CN=7d133d55 876f 4f47 83eb 0ee931cb0a97</screen>
subscribe
</entry>
<entry>
- The <command>PoolID</command> value given for a product when listing available subscriptions. For example:
+ The <command>PoolID</command> value given for a product when listing available subscriptions. For example:
<screen>[root at server1 ~]# subscription-manager list --available
+----------------------+
Available Subscriptions
+----------------------+
ProductName: Red Hat Enterprise Linux, Standard (up to 2 sockets) 3 year
-ProductId: MCT0346F3
+ProductId: MCT0346F3
PoolId: ff8080812bc382e3012bc3845ca000cb
-Quantity: 2
+Quantity: 2
Expires: 2011-02-28</screen>
</entry>
@@ -3609,7 +3607,7 @@ Expires: 2011-02-28</screen>
unsubscribe
</entry>
<entry>
- The SerialNumber line in the product subscription information. This can be returned by running <command>list --consumed</command>.
+ The SerialNumber line in the product subscription information. This can be returned by running <command>list --consumed</command>.
<programlisting language="Bash">[root at server1 ~]# subscription-manager list --consumed
+-----------------------------+
@@ -3617,8 +3615,8 @@ Consumed Product Subscriptions
+-----------------------------+
ProductName: High availability (cluster suite)
-ContractNumber: 0
-SerialNumber: 11287514358600162
+ContractNumber: 0
+SerialNumber: 11287514358600162
....</programlisting>
</entry>
@@ -3635,14 +3633,14 @@ SerialNumber: 11287514358600162
</entry>
<entry>
- The <command>ProductID</command> value given for a product when listing available subscriptions. For example:
+ The <command>ProductID</command> value given for a product when listing available subscriptions. For example:
<screen>[root at server1 ~]# subscription-manager list --available
+----------------------+
Available Subscriptions
+----------------------+
ProductName: RHEL for Physical Servers
-ProductId: MKT-rhel-server
+ProductId: MKT-rhel-server
... snip ...</screen>
</entry>
@@ -3656,10 +3654,10 @@ ProductId: MKT-rhel-server
</table>
</section>
-
+
</section>
-
+
<section id="entitlement-certificates">
<title>About Certificates and Managing Entitlements</title>
<indexterm>
@@ -3679,7 +3677,7 @@ ProductId: MKT-rhel-server
<para>
Each certificate issued and used by the Subscription Manager services is a <filename>.pem</filename> formatted file. This file format stores both keys and certificates in a base-64 blob. For example:
</para>
-
+
<programlisting>-----BEGIN CERTIFICATE-----
MIIDaTCCAtKgAwIBAgICBZYwDQYJKoZIhvcNAQEFBQAwSzEqMCgGA1UEAxMhY2Fu
ZGxlcGluMS5kZXZsYWIucGh4MS5yZWRoYXQuY29tMQswCQYDVQQGEwJVUzEQMA4G
@@ -3702,10 +3700,10 @@ z757igD2hsQ4ewv9Vq3QtnajWnfdaUZH919GgWs09Etg6ucsKwgfx1fqjSRLBbOo
lZuvBTYROOX6W2vKXw==
-----END CERTIFICATE-----</programlisting>
<para>
- Tools like <command>openssl</command> or <command>pk12util</command> can be used to extract and view information from these certificates, in a pretty-print format. The product- and subscription-related information is extracted and viewable in the &OSORG; Subscription Manager GUI or command-line tools.
+ Tools like <command>openssl</command> or <command>pk12util</command> can be used to extract and view information from these certificates, in a pretty-print format. The product- and subscription-related information is extracted and viewable in the Red Hat Subscription Manager GUI or command-line tools.
</para>
<para>
- This section describes the different certificates used by the subscription service and the entitlement information contained in those certificates. A much more detailed description of X.509 certificates and a public key infrastructure (PKI) is given in the &OSORG; Certificate System documentation in <ulink url="http://docs.redhat.com/docs/en-US/Red_Hat_Certificate_System/8.0/html/Deployment_Guide/Introduction_to_Public_Key_Cryptography.html">chapter 1, "Introduction to Public-Key Cryptography,"</ulink> in the <citetitle>&OSORG; Certificate System Deployment Guide</citetitle>.
+ This section describes the different certificates used by the subscription service and the entitlement information contained in those certificates. A much more detailed description of X.509 certificates and a public key infrastructure (PKI) is given in the Red Hat Certificate System documentation in <ulink url="http://docs.redhat.com/docs/en-US/Red_Hat_Certificate_System/8.0/html/Deployment_Guide/Introduction_to_Public_Key_Cryptography.html">chapter 1, "Introduction to Public-Key Cryptography,"</ulink> in the <citetitle>Red Hat Certificate System Deployment Guide</citetitle>.
</para>
<indexterm>
<primary>entitlements</primary>
@@ -3846,7 +3844,7 @@ lZuvBTYROOX6W2vKXw==
</para>
<example id="ex.identity-certs">
<title>Identity Certificate</title>
-
+
<programlisting>Certificate:
Data:
Version: 3 (0x2)
@@ -3881,20 +3879,20 @@ lZuvBTYROOX6W2vKXw==
4d:85
Exponent: 65537 (0x10001)
X509v3 extensions:
- Netscape Cert Type:
+ Netscape Cert Type:
SSL Client, S/MIME
- X509v3 Key Usage:
+ X509v3 Key Usage:
Digital Signature, Key Encipherment, Data Encipherment
- X509v3 Authority Key Identifier:
+ X509v3 Authority Key Identifier:
keyid:68:98:D4:DD:94:B6:E9:71:70:C1:72:D2:3E:A0:40:62:D3:CA:8E:82
DirName:/CN=entitlement.server.example.com/C=US/L=Raleigh
serial:D6:CE:78:B1:56:9C:37:41
- X509v3 Subject Key Identifier:
+ X509v3 Subject Key Identifier:
66:C1:E5:FA:8E:CE:1D:F6:83:85:AA:AF:08:5C:FF:DE:88:BA:92:20
- X509v3 Extended Key Usage:
+ X509v3 Extended Key Usage:
TLS Web Client Authentication
- <userinput>X509v3 Subject Alternative Name:</userinput>
+ <userinput>X509v3 Subject Alternative Name:</userinput>
<userinput>DirName:/CN=admin-example</userinput>
Signature Algorithm: sha1WithRSAEncryption
0d:c4:74:6c:7a:fe:1f:61:f9:c7:3b:d9:18:70:7a:38:51:e2:
@@ -3909,7 +3907,7 @@ lZuvBTYROOX6W2vKXw==
</example>
</section>
-
+
<section id="structure-of-ent-certificates">
<title>The Structure of Entitlement Certificates</title>
<indexterm>
@@ -3941,7 +3939,7 @@ lZuvBTYROOX6W2vKXw==
<para>
The heading of the certificate contains the name of the entitlement server which issued it, the validity period of the certificate (which is tied to the installation date of the product), and then the serial number of the installation of the product.
</para>
-
+
<programlisting>Certificate:
Data:
Version: 3 (0x2)
@@ -3957,14 +3955,14 @@ lZuvBTYROOX6W2vKXw==
<para>
The key definition of the product is given in custom certificate extensions that are appended to the certificate. Each <emphasis>namespace</emphasis> defines certain information about a product, including its name, content servers which can deliver it, the format of delivery, and a GPG key to identify the release. Every individual entry is identified by a numeric object identifier (OID) with the same basic format:
</para>
-
+
<programlisting>1.3.6.1.4.1.2312.9.<userinput>2</userinput>.<replaceable>product_#</replaceable>.<replaceable>config_#</replaceable>:
..<replaceable>config_value</replaceable></programlisting>
<para>
The <command>2</command> indicates that it is a product entry. <emphasis>product_#</emphasis> is a unique ID which identifies the specific product or variant. <emphasis>config_#</emphasis> relates to the installation information for that product, like its content server or the quantity available.
</para>
<note>
- <title>Note</title>
+ <title>OID numbers for entitlements-related extensions</title>
<para>
Every entitlements-related extension begins with the OID base <command>1.3.6.1.4.1.2312.9</command>. The subsequent numbers identify different subscription areas:
</para>
@@ -4002,40 +4000,40 @@ lZuvBTYROOX6W2vKXw==
</para>
<example id="ex.product-extensions">
<title>Annotated &MAJOROS; High Availability Product Extensions in an Entitlement Certificate</title>
-
+
<programlisting>
<replaceable>content repository type</replaceable>
- 1.3.6.1.4.1.2312.9.2.30393.1:
+ 1.3.6.1.4.1.2312.9.2.30393.1:
..yum
<replaceable>product</replaceable>
- 1.3.6.1.4.1.2312.9.2.30393.1.1:
+ 1.3.6.1.4.1.2312.9.2.30393.1.1:
.HRed Hat Enterprise Linux High Availability (for RHEL Entitlement) (RPMs)
<replaceable>channel name</replaceable>
- 1.3.6.1.4.1.2312.9.2.30393.1.2:
+ 1.3.6.1.4.1.2312.9.2.30393.1.2:
.Dred-hat-enterprise-linux-high-availability-for-rhel-entitlement-rpms
<replaceable>vendor</replaceable>
- 1.3.6.1.4.1.2312.9.2.30393.1.5:
+ 1.3.6.1.4.1.2312.9.2.30393.1.5:
..Red Hat
<replaceable>download URL</replaceable>
- 1.3.6.1.4.1.2312.9.2.30393.1.6:
+ 1.3.6.1.4.1.2312.9.2.30393.1.6:
.Q/content/dist/rhel/entitlement/releases/$releasever/$basearch/highavailability/os
<replaceable>key download URL</replaceable>
- 1.3.6.1.4.1.2312.9.2.30393.1.7:
+ 1.3.6.1.4.1.2312.9.2.30393.1.7:
.2file:///etc/pki/rpm-gpg/RPM-GPG-KEY-redhat-release
<replaceable>flex quantity</replaceable>
- 1.3.6.1.4.1.2312.9.2.30393.1.4:
+ 1.3.6.1.4.1.2312.9.2.30393.1.4:
..0
<replaceable>quantity</replaceable>
- 1.3.6.1.4.1.2312.9.2.30393.1.3:
+ 1.3.6.1.4.1.2312.9.2.30393.1.3:
..25
<replaceable>repo enabled setting</replaceable>
- 1.3.6.1.4.1.2312.9.2.30393.1.8:
+ 1.3.6.1.4.1.2312.9.2.30393.1.8:
..1</programlisting>
</example>
</section>
-
+
<section id="structure-of-product-certificates">
<title>The Structure of Product Certificates</title>
<indexterm>
@@ -4062,7 +4060,7 @@ lZuvBTYROOX6W2vKXw==
</para>
</section>
-
+
<section id="sat-certs">
<title>Anatomy of Satellite Certificates</title>
<indexterm>
@@ -4076,7 +4074,7 @@ lZuvBTYROOX6W2vKXw==
<tertiary>satellite certificates</tertiary>
</indexterm>
<important>
- <title>Important</title>
+ <title>Satellite certificates</title>
<para>
Satellite certificates are used by Satellite 5.x deployments. They are not used on &MAJOROSVER; or by the subscription service.
</para>
@@ -4100,7 +4098,7 @@ lZuvBTYROOX6W2vKXw==
</listitem>
<listitem>
<para>
- <emphasis>Channel entitlements</emphasis>, or <emphasis>content entitlements</emphasis>, provide access to the different software product download channels on &OSORG; Network. These include &MAJOROS; add-ons like Supplementary and FastTrack and layered products like &OSORG; Directory Server.
+ <emphasis>Channel entitlements</emphasis>, or <emphasis>content entitlements</emphasis>, provide access to the different software product download channels on Red Hat Network. These include &MAJOROS; add-ons like Supplementary and FastTrack and layered products like Red Hat Directory Server.
</para>
</listitem>
@@ -4112,7 +4110,7 @@ lZuvBTYROOX6W2vKXw==
<para>
A system entitlement and the metadata for an entitlement are both configured similarly in the certificate:
</para>
-
+
<programlisting language="XML"><rhn-cert-field name="<replaceable>configuration_area</replaceable>"><replaceable>value</replaceable></rhn-cert-field></programlisting>
<para>
The <option>name</option> argument identifies what entity is being configured. This can be the organization which ordered the subscription (<option>name="owner"</option>), the start and end dates for the entitlement (<option>name="issued"</option> and <option>name="expires"</option>), or the entitlement itself. A system entitlement uses the <option>name</option> argument to set the service being entitled; every content entitlement is set as a <option>name="channel-family"</option> type, with the specific product identified in an additional <option>family</option> argument.
@@ -4120,7 +4118,7 @@ lZuvBTYROOX6W2vKXw==
<para>
The first section of the Satellite certificate is the metadata. The metadata identifies the organization which purchased it and the start and end dates of the entitlement. The field being set is in the <option>name</option> argument, while the value is between the tags. The last lines of the certificate also set metadata for the subscription, including the version of the Satellite and the signature that signs the XML document (and allows the XML file to be used as a certificate).
</para>
-
+
<programlisting language="XML">
<rhn-cert-field name="product">RHN-SATELLITE-001</rhn-cert-field>
<rhn-cert-field name="owner">Example Corp</rhn-cert-field>
@@ -4143,43 +4141,43 @@ aPcaAJ0e5neOfdDZRLOgDE+Tp/Im3Hc3Rg==
<para>
The <option>name="slot"</option> field lists how many <emphasis>total</emphasis> systems are allowed to use this Satellite certificate to receive content. It's a global quantity.
</para>
-
+
<programlisting language="XML"> <rhn-cert-field name="slots">119</rhn-cert-field></programlisting>
<para>
The system entitlements are set by identifying the service type in the <option>name</option> argument and then setting the quantity as the value within the tags.
</para>
-
+
<programlisting language="XML"> <rhn-cert-field name="provisioning-slots">117</rhn-cert-field>
<rhn-cert-field name="monitoring-slots">20</rhn-cert-field>
<rhn-cert-field name="virtualization_host">67</rhn-cert-field></programlisting>
<para>
The content entitlements can include any combination of products, including base &MAJOROS; subscriptions, variations of &MAJOROS;, &MAJOROS; add-ons, and general software products. General &MAJOROS; server subscriptions are listed in the <option>rhel-server</option> family, while a specific Virtualization Server subscription provides an additional <option>rhel-server-vt</option> family..
</para>
-
+
<programlisting language="XML">
<rhn-cert-field name="channel-families" quantity="95" family="rhel-server"/>
<rhn-cert-field name="channel-families" quantity="67" family="rhel-server-vt"/>
</programlisting>
<para>
- Add-ons and products for &MAJOROS; systems (but not necessarily operating system products) are also in a <option>rhel-*</option> family, because that refers to the platform the product is supported on. In this example, &OSORG; Directory Server is in the <option>rhel-rhdirserv</option> family.
+ Add-ons and products for &MAJOROS; systems (but not necessarily operating system products) are also in a <option>rhel-*</option> family, because that refers to the platform the product is supported on. In this example, Red Hat Directory Server is in the <option>rhel-rhdirserv</option> family.
</para>
-
+
<programlisting language="XML">
<rhn-cert-field name="channel-families" quantity="3" family="rhel-rhdirserv"/>
</programlisting>
<para>
Most subscriptions will also include a subscription tool set to manage and enable within clients features such as provisioning or configuration management when registered to RHN Classic or Satellite 5.x.
</para>
-
+
<programlisting language="XML">
<rhn-cert-field name="channel-families" quantity="212" family="rhn-tools"/>
</programlisting>
</section>
-
+
</section>
-
+
</chapter>
diff --git a/en-US/Yum.xml b/en-US/Yum.xml
index 13b7b24..62eb399 100644
--- a/en-US/Yum.xml
+++ b/en-US/Yum.xml
@@ -178,7 +178,7 @@ Is this ok [y/N]:</screen>
<application>security</application> plugin
</primary>
<see>Security</see>
- </indexterm>
+ </indexterm>
<para>
Discovering which packages have security updates available and then updating those packages quickly and easily is important. <application>Yum</application> provides the plugin for this purpose. The <application>security</application> plugin extends the <command>yum</command> command with a set of highly-useful security-centric commands, subcommands and options. Refer to <xref linkend="sec-Plugin_Descriptions" /> for specific information.
</para>
@@ -726,7 +726,7 @@ Done</screen>
The <filename>/etc/yum.conf</filename> configuration file contains one mandatory <literal>[main]</literal> section under which you can set <application>Yum</application> options. The values that you define in the <literal>[main]</literal> section of <filename>yum.conf</filename> have global effect, and may override values set in individual <literal>[<replaceable>repository</replaceable>]</literal> sections. You can also add <literal>[<replaceable>repository</replaceable>]</literal> sections to <filename>/etc/yum.conf</filename>; however, best practice is to define individual repositories in new or existing <filename class="extension">.repo</filename> files in the <filename class="directory">/etc/yum.repos.d/</filename>directory. Refer to <xref linkend="sec-Setting_repository_Options" /> if you need to add or edit repository-specific information.
</para>
<important>
- <title>The <filename>/etc/yum.repos.d/redhat.repo</filename> file</title>
+ <title>The /etc/yum.repos.d/redhat.repo file</title>
<para>
When the system is registered with the certificate-based <systemitem class="systemname">Red Hat Network</systemitem>, the <application>Red Hat Subscription Manager</application> tools are used to manage repositories in the <filename>/etc/yum.repos.d/redhat.conf</filename> file. Refer to <xref linkend="entitlements" /> for more information how to register a system with <systemitem class="systemname">Red Hat Network</systemitem> and use the <application>Red Hat Subscription Manager</application> tools to manage subscriptions.
</para>
@@ -1179,7 +1179,7 @@ sslclientcert = /etc/pki/entitlement/11300387955690106.pem</programlisting>
</para>
<screen>~]# <command>createrepo --database /mnt/local_repo</command></screen>
<important>
- <title>Using the <command>createrepo</command> command on &MAJOROS; 5</title>
+ <title>Using the createrepo command on &MAJOROS; 5</title>
<para>
Because RPM packages for &MAJOROSVER; are compressed using the XZ lossless data compression format, and may also be signed using alternative (and stronger) hash algorithms such as SHA-256, it is not possible to run <command>createrepo</command> on &MAJOROS; 5 to create the package metadata for &MAJOROSVER; packages. The <command>createrepo</command> command relies on <command>rpm</command> to open and inspect the packages, and <command>rpm</command> on &MAJOROS; 5 is not able to open the improved &MAJOROSVER; RPM package format.
</para>
More information about the docs-commits
mailing list