Update Managing RH Subscriptions with content from KCS article #3623
Conversation
|
The PR preview for cc0f76a is available at theforeman-foreman-documentation-preview-pr-3623.surge.sh The following output files are affected by this PR: |
There was a problem hiding this comment.
Can we cull the content that isn't relevant to Foreman/Satellite? 🤔
Edit: I checked the ticket and I see that it's actually a requirement. I disagree with some of the requirements in the ticket. I don't think we should duplicate the content from Subscriptions Central. I'm not sure how to approach this.
pr-processor
bot
added
Waiting on contributor
Lennonka
added
Needs tech review
|
|
||
| Connected {Project} Users should enable the `foreman_rh_cloud` plugin if it hasn’t been enabled already (https://docs.redhat.com/en/documentation/subscription_central/1-latest/html/getting_started_with_the_subscriptions_service/proc-installing-satellite-inventory-upload-plugin_assembly-setting-up-subscriptionwatch-ctxt). The foreman_rh_cloud plugin shares inventory with the Hybrid Cloud Console enabling the usage of the subscriptions service to track usage information. | ||
|
|
||
| The plugin can be configured to omit data that is not pertinent for subscription purposes such as hostnames & IP addresses. |
There was a problem hiding this comment.
| The plugin can be configured to omit data that is not pertinent for subscription purposes such as hostnames & IP addresses. | |
| The plugin can be configured to omit data that is not pertinent for subscription purposes, such as host names and IP addresses. |
Are you sure this is ready for style review?
|
|
||
| Connected {Project} Users:: | ||
|
|
||
| Connected {Project} Users should enable the `foreman_rh_cloud` plugin if it hasn’t been enabled already (https://docs.redhat.com/en/documentation/subscription_central/1-latest/html/getting_started_with_the_subscriptions_service/proc-installing-satellite-inventory-upload-plugin_assembly-setting-up-subscriptionwatch-ctxt). The foreman_rh_cloud plugin shares inventory with the Hybrid Cloud Console enabling the usage of the subscriptions service to track usage information. |
There was a problem hiding this comment.
RHSSG says to avoid contractions unless the context is informal (example: marketing).
There was a problem hiding this comment.
This may need an if-ndef for Satellite. foreman_rh_cloud is included with Satellite and enabled by default, so this sentence would only apply to upstream.
| @@ -19,6 +19,55 @@ The advantage of this is that each organization maintains separate subscriptions | |||
| You can use future-dated subscriptions in a subscription manifest. | |||
| When you add future-dated subscriptions to your manifest before the expiry date of the existing subscriptions, you can have uninterrupted access to repositories. | |||
|
|
|||
| .Benefits of the subscriptions service | |||
| * Tracks selected Red Hat product usage and capacity at the fleet or account level in a unified inventory and provides a daily snapshot of that data in a digestible, filterable dashboard at cloud.redhat.com. | |||
There was a problem hiding this comment.
I think you might want to rewrite some of this content so that it sounds less like marketing ("make data-driven choices" with portfolio-centered reporting dashboards").
Chains of adjectives like "digestible, filterable dashboard" or "inventory-occupying subscriptions" might be problematic for machine translation.
| * Helps procurement officers make data-driven choices with portfolio-centered reporting dashboards that show both inventory-occupying subscriptions and current subscription limits across the entire organization. | ||
| * With its robust reporting capabilities, enables the transition to Simple Content Access (SCA) tooling that features broader, organizational-level subscription enforcement instead of system-level quantity enforcement. | ||
|
|
||
| Simple Content Access (SCA) is a capability in Red Hat’s subscription tools which simplifies the behavior of the entitlement tooling, making it easier to consume the content provided by your Red Hat subscriptions without the complexity of configuring subscription tooling. |
There was a problem hiding this comment.
It's a "capability"? I'm not sure the user will understand what that word means in this context.
"which simplifies". See ISG on word usage for "that/which".
There was a problem hiding this comment.
I don't think anything explaining what SCA is is needed in Satellite documentation. SCA is the only option anyway.
| Connected (Non-{Project}) users:: | ||
|
|
||
| As a connected, non-{Project} user, no further action needs to be taken to use the subscriptions service. | ||
| For more information, see https://console.redhat.com/subscriptions/usage/rhel to track your usage. |
There was a problem hiding this comment.
In my experience, "For more information" precedes links to documentation. This sounds more like "You can log in to the Hybrid Cloud Console to track your subscription usage." In other words, logging in to the console is going to provide usage info, not more information about the subscriptions service.
| * Helps procurement officers make data-driven choices with portfolio-centered reporting dashboards that show both inventory-occupying subscriptions and current subscription limits across the entire organization. | ||
| * With its robust reporting capabilities, enables the transition to Simple Content Access (SCA) tooling that features broader, organizational-level subscription enforcement instead of system-level quantity enforcement. | ||
|
|
||
| Simple Content Access (SCA) is a capability in Red Hat’s subscription tools which simplifies the behavior of the entitlement tooling, making it easier to consume the content provided by your Red Hat subscriptions without the complexity of configuring subscription tooling. |
There was a problem hiding this comment.
I don't think anything explaining what SCA is is needed in Satellite documentation. SCA is the only option anyway.
| @@ -19,6 +19,55 @@ The advantage of this is that each organization maintains separate subscriptions | |||
| You can use future-dated subscriptions in a subscription manifest. | |||
| When you add future-dated subscriptions to your manifest before the expiry date of the existing subscriptions, you can have uninterrupted access to repositories. | |||
|
|
|||
| .Benefits of the subscriptions service | |||
There was a problem hiding this comment.
This title doesn't make it clear at all that we're now talking about the Subscriptions service of console.redhat.com, rather than subscriptions that you add to your manifest. I'm a bit confused why this section is being added here.
|
|
||
| Simple Content Access (SCA) is a capability in Red Hat’s subscription tools which simplifies the behavior of the entitlement tooling, making it easier to consume the content provided by your Red Hat subscriptions without the complexity of configuring subscription tooling. | ||
|
|
||
| The subscriptions service, hosted at console.redhat.com provides a means for customers to view their subscription usage and can show usage data from both connected and disconnected environments if configured to do so. |
There was a problem hiding this comment.
This sentence seems like it would make a good introductory sentence, rather than a final sentence.
|
|
||
| The subscriptions service, hosted at console.redhat.com provides a means for customers to view their subscription usage and can show usage data from both connected and disconnected environments if configured to do so. | ||
|
|
||
| .Configuring your system to use the subscription services |
There was a problem hiding this comment.
| .Configuring your system to use the subscription services | |
| .Configuring your system to use the Subscriptions service |
Let's standardize the name of the service.
| As a connected, non-{Project} user, no further action needs to be taken to use the subscriptions service. | ||
| For more information, see https://console.redhat.com/subscriptions/usage/rhel to track your usage. | ||
| Registering a system through the guidance in https://docs.redhat.com/en/documentation/subscription_central/1-latest/html-single/getting_started_with_rhel_system_registration/index[Getting Started with RHEL System Registration] is sufficient to ensure the system is properly counted. | ||
| If necessary, set https://access.redhat.com/articles/system-purpose[System Purpose] attributes to denote SLA and USAGE to better power filtering. |
There was a problem hiding this comment.
I would upgrade this from "if necessary" to a recommendation. Setting system purpose attributes improves reporting in the Subscriptions service.
|
|
||
| Connected {Project} Users:: | ||
|
|
||
| Connected {Project} Users should enable the `foreman_rh_cloud` plugin if it hasn’t been enabled already (https://docs.redhat.com/en/documentation/subscription_central/1-latest/html/getting_started_with_the_subscriptions_service/proc-installing-satellite-inventory-upload-plugin_assembly-setting-up-subscriptionwatch-ctxt). The foreman_rh_cloud plugin shares inventory with the Hybrid Cloud Console enabling the usage of the subscriptions service to track usage information. |
There was a problem hiding this comment.
This may need an if-ndef for Satellite. foreman_rh_cloud is included with Satellite and enabled by default, so this sentence would only apply to upstream.
|
|
||
| Disconnected (No {Project}):: | ||
|
|
||
| As a disconnected user, you can use Red Hat Discovery to query standalone RHEL systems or tools such as {ProjectName} to build a report locally. |
There was a problem hiding this comment.
Shouldn't we assume the Satellite user doesn't know what Red Hat Discovery is, and link to something explaining that?
There was a problem hiding this comment.
Actually, I thought Red Hat Discovery is for disconnected users without Satellite, and the foreman_rh_cloud reports and Satellite host installed products report is for disconnected Satellite users.
| ** Through the `foreman_rh_cloud` plugin, which generates its report locally and allows you the ability to download it. | ||
| This report is in JSON format and is most suitable for automated scripts or machine ingestion. | ||
| This report can also be generated through the `foreman-rake` command. |
There was a problem hiding this comment.
What foreman-rake command? Or, can we at least link to the documentation that tells you how to run that report?
| This report can also be generated through the `foreman-rake` command. | ||
|
|
||
| ** Through the *Host - Installed Products* report by navigating to *Monitor* > *Reports* > *Report Templates*. | ||
| This report is in CSV format and is most suitable for importing into a spreadsheet tool of your choosing. |
There was a problem hiding this comment.
Report templates can be exported in the format of your choosing, including HTML, YAML, or CSV. It's not only CSV.
| As a connected, non-{Project} user, no further action needs to be taken to use the subscriptions service. | ||
| For more information, see https://console.redhat.com/subscriptions/usage/rhel to track your usage. | ||
| Registering a system through the guidance in https://docs.redhat.com/en/documentation/subscription_central/1-latest/html-single/getting_started_with_rhel_system_registration/index[Getting Started with RHEL System Registration] is sufficient to ensure the system is properly counted. | ||
| If necessary, set https://access.redhat.com/articles/system-purpose[System Purpose] attributes to denote SLA and USAGE to better power filtering. |
There was a problem hiding this comment.
This 'system purpose' article is very old. Please link to RHEL documentation instead.
What changes are you introducing?
Content from https://access.redhat.com/subscription_mgmt_guide_for_RHEL
added to Managing Red Hat subscriptions.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
In reference to https://issues.redhat.com/browse/SAT-29714
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Also added definition of Simple Content Access (SCA) per ticket.
Checklists
Please cherry-pick my commits into: