-
Notifications
You must be signed in to change notification settings - Fork 107
Rework docs for Alternate Content Sources (ACS) #4492
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
maximiliankolb
merged 12 commits into
theforeman:master
from
ATIX-AG:alternate_content_sources
Dec 15, 2025
Merged
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
64f7217
Simplify anchors for ACS modules
maximiliankolb 6a93c1e
Split ACS modules by interface
maximiliankolb a6543e4
Reword ACS modules
maximiliankolb d795a8a
Move ACS permissions into separate module
maximiliankolb 1257518
Fix description of ACS content flow for Smart Proxy Servers
maximiliankolb 0a19da3
Fix typo in anchor for ACS
maximiliankolb 35abc99
Reword ACS modules again
maximiliankolb aaf8994
Rename ACS modules
maximiliankolb 67dc561
Fix spelling of successfully
maximiliankolb cda3fa5
Apply feedback by Lena
maximiliankolb 84eb9ff
Apply feedback by AI
maximiliankolb 70c36e1
Apply feedback by Lena
maximiliankolb File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
63 changes: 0 additions & 63 deletions
63
guides/common/modules/proc_configuring-custom-alternate-content-sources.adoc
This file was deleted.
Oops, something went wrong.
77 changes: 0 additions & 77 deletions
77
guides/common/modules/proc_configuring-rhui-alternate-content-sources.adoc
This file was deleted.
Oops, something went wrong.
41 changes: 0 additions & 41 deletions
41
guides/common/modules/proc_configuring-simplified-alternate-content-sources.adoc
This file was deleted.
Oops, something went wrong.
40 changes: 40 additions & 0 deletions
40
...common/modules/proc_creating-custom-alternate-content-sources-by-using-cli.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| :_mod-docs-content-type: PROCEDURE | ||
|
|
||
| [id="creating-custom-alternate-content-sources-by-using-cli"] | ||
| = Creating custom alternate content sources by using Hammer CLI | ||
|
|
||
| [role="_abstract"] | ||
| You can create custom alternate content sources (ACS) to define alternate paths to download content during synchronization. | ||
|
|
||
| .Prerequisites | ||
| * If the repository requires SSL authentication, import the SSL certificate and key into {Project}. | ||
| For more information, see {ContentManagementDocURL}importing-custom-ssl-certificates-by-using-cli[Importing custom SSL certificates by using Hammer CLI] in _{ContentManagementDocTitle}_. | ||
| * You have the base URL and subpaths of your alternate content source. | ||
| For example, if your base URL is `\https://{server-example-com}` and your subpaths are `rhel10/` and `rhel9/`, then {Project} will search `\https://{server-example-com}/rhel10/` and `\https://{server-example-com}/rhel9/`. | ||
|
|
||
| .Procedure | ||
| . Create a custom alternate content source: | ||
| + | ||
| [options="nowrap" subs="+quotes,attributes"] | ||
| ---- | ||
| $ hammer alternate-content-source create \ | ||
| --alternate-content-source-type custom \ | ||
| --base-url "_https://local-repo.example.com:port_" \ | ||
| --name "_My_ACS_Name_" \ | ||
| --smart-proxy-ids __My_{smart-proxy-context-titlecase}_ID_1__,__My_{smart-proxy-context-titlecase}_ID_2__ \ | ||
| --verify-ssl _true_ | ||
| ---- | ||
| . Refresh your alternate content source: | ||
| + | ||
| [options="nowrap" subs="+quotes,attributes"] | ||
| ---- | ||
| $ hammer alternate-content-source refresh --name "_My_ACS_Name_" | ||
| ---- | ||
|
|
||
| .Verification | ||
| * Verify that the task ran successfully: | ||
| + | ||
| [options="nowrap" subs="+quotes,attributes"] | ||
| ---- | ||
| $ hammer task list --search "Refresh Alternate Content Source" | ||
| ---- |
35 changes: 35 additions & 0 deletions
35
...mon/modules/proc_creating-custom-alternate-content-sources-by-using-web-ui.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| :_mod-docs-content-type: PROCEDURE | ||
|
|
||
| [id="creating-custom-alternate-content-sources-by-using-web-ui"] | ||
| = Creating custom alternate content sources by using {ProjectWebUI} | ||
|
|
||
| [role="_abstract"] | ||
| You can create custom alternate content sources (ACS) to define alternate paths to download content during synchronization. | ||
|
|
||
| .Prerequisites | ||
| * If the repository requires SSL authentication, import the SSL certificate and key into {Project}. | ||
| For more information, see {ContentManagementDocURL}Importing_Custom_SSL_Certificates_content-management[Importing {customssl} certificates] in _{ContentManagementDocTitle}_. | ||
| * You have the base URL and subpaths of your alternate content source. | ||
| For example, if your base URL is `\https://{server-example-com}` and your subpaths are `rhel10/` and `rhel9/`, then {Project} will search `\https://{server-example-com}/rhel10/` and `\https://{server-example-com}/rhel9/`. | ||
|
|
||
| .Procedure | ||
| . In the {ProjectWebUI}, navigate to *Content* > *Alternate Content Sources*. | ||
| . Click *Add source*. | ||
| . Set the *Source type* to *Custom*. | ||
| . Select the *Content type* from the drop-down list. | ||
| . In the *Name* field, enter a name for your custom ACS. | ||
| . Optional: In the *Description* field, provide a description for the ACS. | ||
| . Select {SmartProxies} to which you want to synchronize content from your alternate content source. | ||
| . If you require synchronizing content through the HTTP proxy of your {SmartProxies}, select *Use HTTP proxies*. | ||
| . In the *Base URL* field, enter the base URL of the alternate content source. | ||
| . In the *Subpaths* field, provide a comma-separated list of subpaths. | ||
| . If your alternate content source requires authentication, select the *Manual authentication* or *Content credentials*. | ||
| . If SSL verification is required, enable *Verify SSL* and select the SSL CA certificate. | ||
| . Click *Add*. | ||
| . Navigate to *Content* > *Alternate Content Sources*. | ||
| . Click the vertical ellipsis next to the newly created alternate content source and click *Refresh*. | ||
|
|
||
| .Verification | ||
| . In the {ProjectWebUI}, navigate to *Monitor* > *{Project} Tasks* > *Tasks*. | ||
| . Search for `Refresh Alternate Content Source`. | ||
| . Verify that the task finished successfully. |
43 changes: 43 additions & 0 deletions
43
...s/common/modules/proc_creating-rhui-alternate-content-sources-by-using-cli.adoc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| :_mod-docs-content-type: PROCEDURE | ||
|
|
||
| [id="creating-rhui-alternate-content-sources-by-using-cli"] | ||
| = Creating RHUI alternate content sources by using Hammer CLI | ||
|
|
||
| [role="_abstract"] | ||
| You can use RHUI alternate content sources to configure your {SmartProxy} to sync content from a Red{nbsp}Hat Update Infrastructure server. | ||
|
|
||
| .Prerequisites | ||
| * Generate the client entitlement certificates for the required repos on the RHUA node as described in {RHDocsBaseURL}red_hat_update_infrastructure/4/html/configuring_and_managing_red_hat_update_infrastructure/assembly_cmg-creating-client-ent-cert-config-rpm_configuring-and-managing-red-hat-update-infrastructure#proc_cmg-creating-client-entitlement-certificate_assembly_cmg-creating-client-ent-cert-config-rpm[Creating a client entitlement certificate with the Red Hat Update Infrastructure Management Tool] in _Configuring and Managing Red Hat Update Infrastructure_. | ||
| * Import the client entitlement certificates into {Project}. | ||
| For more information, see {ContentManagementDocURL}importing-custom-ssl-certificates-by-using-cli[Importing custom SSL certificates by using Hammer CLI] in _{ContentManagementDocTitle}_. | ||
| * Obtain a list of the subpaths for the required repositories. | ||
| Execute the following command on your RHUA server: | ||
| + | ||
| [options="nowrap" subs="+quotes,attributes"] | ||
| ---- | ||
| # rhui-manager repo info --repo_id _My_Repo_ID_ | ||
| ---- | ||
| * Note that the alternate content source paths consist of a base URL appended with the subpaths that you provide. | ||
| For example, if your base URL is `\https://{server-example-com}` and your subpaths are `rhel7/` and `rhel8/`, then both `\https://{server-example-com}/rhel7/` and `\https://{server-example-com}/rhel8/` will be searched. | ||
|
|
||
| .Procedure | ||
| . Create a RHUI alternate content source: | ||
| + | ||
| [options="nowrap" subs="+quotes,attributes"] | ||
| ---- | ||
| $ hammer alternate-content-source create \ | ||
| --alternate-content-source-type rhui \ | ||
| --base-url "_https://rhui-cds-node.example.com/pulp/content_" \ | ||
| --name "_My_ACS_Name_" \ | ||
| --smart-proxy-ids __My_{smart-proxy-context-titlecase}_ID_1__,__My_{smart-proxy-context-titlecase}_ID_2__ \ | ||
| --ssl-client-cert-id _My_SSL_Client_Certificate_ID_ \ | ||
| --ssl-client-key-id _My_SSL_Client_Key_ID_ \ | ||
| --subpaths _path/to/repo/1/,path/to/repo/2/_ \ | ||
| --verify-ssl _true_ | ||
| ---- | ||
| . Refresh the alternate content source: | ||
| + | ||
| [options="nowrap" subs="+quotes,attributes"] | ||
| ---- | ||
| $ hammer alternate-content-source refresh --name "_My_ACS_Name_" | ||
| ---- |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.