Skip to content

Optimize (CQA) - Mng content - Content access control#4822

Open
Lennonka wants to merge 2 commits intotheforeman:masterfrom
Lennonka:premig-mng-cont-access-control
Open

Optimize (CQA) - Mng content - Content access control#4822
Lennonka wants to merge 2 commits intotheforeman:masterfrom
Lennonka:premig-mng-cont-access-control

Conversation

@Lennonka
Copy link
Copy Markdown
Contributor

@Lennonka Lennonka commented May 6, 2026

What changes are you introducing?

Improving the Content access control chapter of Managing content

  • optimization of abstracts and a title

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

Content Quality Assessment for DITA migration:

  • Title and abstract optimization: SEO and GEO (AI-friendly)

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

  • AI + human
  • No changes in prerequisites - added prerequisites would require tech review
  • Tech review shouldn't be needed. LMK if unsure.

Contributor checklists

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.18/Katello 4.20 (Satellite 6.19)
  • Foreman 3.17/Katello 4.19
  • Foreman 3.16/Katello 4.18 (Satellite 6.18; orcharhino 7.6, 7.7, and 7.8)
  • Foreman 3.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4; orcharhino 7.5)
  • Foreman 3.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16; orcharhino 7.2 on EL9 only; orcharhino 7.3)
  • We do not accept PRs for Foreman older than 3.12.

@github-actions github-actions Bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels May 6, 2026
@Lennonka Lennonka removed Needs tech review Requires a review from the technical perspective Needs testing Requires functional testing labels May 6, 2026
@Lennonka Lennonka force-pushed the premig-mng-cont-access-control branch from 9d3c1cc to 814fb03 Compare May 6, 2026 20:04
@Lennonka
Copy link
Copy Markdown
Contributor Author

Lennonka commented May 6, 2026

Rebased on master.

Comment thread guides/common/modules/con_content-access-control-for-hosts.adoc
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 6, 2026

[role="_abstract"]
Activation keys simplify the workflow for some of the content access strategies.
During registration, you use activation keys to assign content view environments, attach content overrides, and set system purpose attributes so hosts inherit the repository access you intend.
After registration, adjust access per host or through bulk actions instead of changing the keys.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would avoid shortening "activation keys" to "keys":

Suggested change
After registration, adjust access per host or through bulk actions instead of changing the keys.
After registration, adjust access per host or through bulk actions instead of changing the activation keys.


[role="_abstract"]
Activation keys simplify the workflow for some of the content access strategies.
During registration, you use activation keys to assign content view environments, attach content overrides, and set system purpose attributes so hosts inherit the repository access you intend.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If possible, I suggest to leave out system purposes because it's RHEL only. It does not work for EL/Deb/SLES.


[role="_abstract"]
A host can access a package or repository only when all of the following conditions are true.
A host reaches a repository only when that repository is in a content view environment of the host, survives filters, is enabled, and matches any architecture or operating system version restrictions.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reaches -> can access

"reaches" reminds me too much of network connectivity. "survives" feels off to me in docs.

{Project} provides a robust set of strategies for controlling what content is accessible to your hosts.
You can restrict content access by using core mechanisms, such as content views, lifecycle environments, and content overrides.
You can use activation keys to apply these content access controls during host registration.
You can cap host access to repositories and packages with lifecycle-bound content views, overrides, composite views, and strict architecture or release rules that you evaluate in a deliberate order.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"lifecycle-bound" -> should be lifecycle environement or an explanation what a lifecycle in Katello stands for.

[role="_abstract"]
To give hosts access to a specific subset of the content managed by {Project}, you can use the following strategies.
You narrow which repositories and packages registered hosts consume from {Project} by combining content views, lifecycle environments, overrides, and tighter rules where needed.
Evaluate those options from broad lifecycle design through overrides toward the strictest architecture or release limits.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does "broad lifecycle design" mean? I suggest to reword it to include "lifecycle environement" or maybe describe that this is the base set, and then users can apply filters that act as restrictions/options to reduce the set of packages for hosts later on.

@Lennonka Lennonka added the Waiting on contributor Requires an action from the author label May 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Needs style review Requires a review from docs style/grammar perspective Waiting on contributor Requires an action from the author

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants