Managing alternate content sources

You can accelerate content synchronization for your orcharhino Server and orcharhino Proxy Servers by creating alternate content sources. Use an alternate content source on your local filesystem or nearby network to download content faster while still receiving metadata from the upstream source.

An alternate content source (ACS) defines an alternate path to download content during synchronization. The content itself is downloaded from the ACS, while the metadata is downloaded from the orcharhino Server or the upstream URL, depending on the configuration. You can use ACS to accelerate synchronization if the content is located on the local filesystem or on a nearby network. You can set up ACS for orcharhino Server and orcharhino Proxy Servers.

You must refresh the alternate content source after creation or after making any changes. A weekly cron job refreshes all alternate content sources. You can also refresh the alternate content sources manually by using the orcharhino management UI or Hammer CLI. Alternate content sources associated with your orcharhino Server, or orcharhino Proxy Servers attached to multiple organizations, affect all organizations.

There are the following types of alternate content sources:

Custom

Custom alternate content sources download the content from any upstream repository on the network or filesystem.

Simplified

Simplified alternate content sources copy the upstream repository information from your orcharhino Server for the selected products. Simplified alternate content sources are ideal for situations where the connection from your orcharhino Proxy Server to the upstream repository is faster than to your orcharhino Server.

RHUI

RHUI alternate content sources download content from a Red Hat Update Infrastructure (RHUI) server. orcharhino management UI provides examples to help you find the network paths and to import authentication credentials.

Creating a custom alternate content source by using orcharhino management UI

You can create a custom alternate content source (ACS) to accelerate content synchronization by downloading from your local network or filesystem instead of remote upstream servers.

Prerequisites

  • If the repository requires SSL authentication, the SSL certificate and key must be imported into orcharhino. For more information, see Importing custom SSL certificates by using orcharhino management UI in Managing Content.

  • 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 red_hat_enterprise_linux-10/ and red_hat_enterprise_linux-9/, then orcharhino will search https://server.example.com/red_hat_enterprise_linux-10/ and https://server.example.com/red_hat_enterprise_linux-9/.

Procedure

  1. In the orcharhino management UI, navigate to Content > Alternate Content Sources.

  2. Click Add source.

  3. Set the Source type to Custom.

  4. Select the Content type from the drop-down list.

  5. In the Name field, enter a name for your custom ACS.

  6. Optional: In the Description field, provide a description for the ACS.

  7. Select orcharhino Proxies to which you want to synchronize content from your alternate content source.

  8. If you require synchronizing content through the HTTP proxy of your orcharhino Proxies, select Use HTTP proxies.

  9. In the Base URL field, enter the base URL of the alternate content source.

  10. In the Subpaths field, provide a comma-separated list of subpaths.

  11. If your alternate content source requires authentication, select the Manual authentication or Content credentials.

  12. If SSL verification is required, enable Verify SSL and select the SSL CA certificate.

  13. Click Add.

  14. Navigate to Content > Alternate Content Sources.

  15. Open the options menu next to the newly created alternate content source and click Refresh.

Verification

  1. In the orcharhino management UI, navigate to Monitor > orcharhino Tasks > Tasks.

  2. Search for Refresh Alternate Content Source.

  3. Verify that the task finished successfully.

Creating a custom alternate content source by using Hammer CLI

You can create a custom alternate content source (ACS) to accelerate content synchronization by downloading from your local network or filesystem instead of remote upstream servers.

Prerequisites

  • If the repository requires SSL authentication, the SSL certificate and key must be imported into orcharhino. For more information, see Importing custom SSL certificates by using Hammer CLI in Managing Content.

  • 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 red_hat_enterprise_linux-10/ and red_hat_enterprise_linux-9/, then orcharhino will search https://server.example.com/red_hat_enterprise_linux-10/ and https://server.example.com/red_hat_enterprise_linux-9/.

Procedure

  1. Create a custom alternate content source:

    $ 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_orcharhino_Proxy_ID_1,My_orcharhino_Proxy_ID_2 \
--subpaths "My_Subpath_1/,_My_Subpath_2/," \
--verify-ssl _true

  2. Refresh your alternate content source:

    $ hammer alternate-content-source refresh --name "My_ACS_Name"
Verification

  • Verify that the task ran successfully:

    $ hammer task list --search "Refresh Alternate Content Source"

Creating a simplified alternate content source by using orcharhino management UI

You can create a simplified alternate content source (ACS) when your orcharhino Proxy Servers have faster connections to the upstream repository than to your orcharhino Server. This accelerates synchronization by downloading content directly from the upstream source.

Prerequisites

  • You have created the products that will use the alternate content source.

Procedure

  1. In the orcharhino management UI, navigate to Content > Alternate Content Sources.

  2. Click Add source.

  3. Set the Source type to Simplified.

  4. Select the Content type from the drop-down list.

  5. In the Name field, enter a name for your simplified ACS.

  6. Optional: In the Description field, provide a description for the ACS.

  7. Select orcharhino Proxies to which you want to synchronize content from your alternate content source.

  8. If you require synchronizing content through the HTTP proxy of your orcharhino Proxies, select Use HTTP proxies.

  9. Select the products that should use the alternate content source.

  10. Click Add.

  11. Navigate to Content > Alternate Content Sources.

  12. Open the options menu next to the newly created alternate content source and click Refresh.

Verification

  1. In the orcharhino management UI, navigate to Monitor > orcharhino Tasks > Tasks.

  2. Search for Refresh Alternate Content Source.

  3. Verify that the task finished successfully.

Creating a simplified alternate content source by using Hammer CLI

You can create a simplified alternate content source (ACS) when your orcharhino Proxy Servers have faster connections to the upstream repository than to your orcharhino Server. This accelerates synchronization by downloading content directly from the upstream source.

Prerequisites

  • You have created the products that will use the alternate content source.

Procedure

  1. Create a simplified alternate content source:

    $ hammer alternate-content-source create \
--alternate-content-source-type simplified \
--content-type yum \
--name "My_ACS_Name" \
--product-ids My_Product_ID_1,My_Product_ID_2 \
--smart-proxy-ids My_orcharhino_Proxy_ID_1,My_orcharhino_Proxy_ID_2

    Use --content-type file if you want to create a simplified ACS for a product with file-type repositories.

  2. Refresh your alternate content source:

    $ hammer alternate-content-source refresh --name "My_ACS_Name"
Verification

  • Verify that the task ran successfully:

    $ hammer task list --search "Refresh Alternate Content Source"

Synchronizing orcharhino Proxy directly from Red Hat CDN by using orcharhino management UI

You can configure your orcharhino Proxy Servers to sync Red Hat content directly from the Red Hat CDN to reduce load on your orcharhino Server and accelerate content synchronization.

Prerequisites

  • The required Red Hat repositories are enabled in orcharhino.

Procedure

  1. In the orcharhino management UI, navigate to Content > Alternate Content Sources.

  2. Click Add source.

  3. Set the Source type as Simplified.

  4. Set the Content type to Yum.

  5. In the Name field, enter a name for the alternate content source.

  6. Optional: In the Description field, provide a description for the alternate content source.

  7. Select orcharhino Proxies that you want to sync directly from Red Hat CDN.

  8. If you require synchronizing content through the HTTP proxy of your orcharhino Proxies, select Use HTTP proxies.

  9. Select the Red Hat products that should be synced to the orcharhino Proxy from Red Hat CDN.

  10. Review details and click Add.

  11. Navigate to Content > Alternate Content Sources, click the options icon next to the newly created alternate content source, and select Refresh.

Creating an RHUI alternate content source by using orcharhino management UI

You can create an RHUI alternate content source (ACS) to synchronize content from your Red Hat Update Infrastructure (RHUI) server. Leverage your existing RHUI investment and accelerate content synchronization.

orcharhino searches content paths that combine a base URL with subpaths. For example, if your base URL is https://server.example.com and your subpaths are rhel10/ and rhel9/, then orcharhino searches https://server.example.com/rhel10/ and https://server.example.com/rhel9/.

Prerequisites
Procedure

  1. On your RHUA server, display details for the required repositories:

    $ rhui-manager repo info --repo_id My_Repo_ID

    Record the relative paths from the command output to use as subpaths.

  2. In the orcharhino management UI, navigate to Content > Alternate Content Sources.

  3. Click Add source.

  4. Set the Source type to RHUI.

  5. Generate RHUI certificates using the command provided in the orcharhino management UI. Ensure that you pass the repo labels of the desired repositories.

  6. In the Name field, enter a name for your RHUI ACS.

  7. Optional: In the Description field, provide a description for the ACS.

  8. Select orcharhino Proxies to which you want to synchronize content from your alternate content source.

  9. If you require synchronizing content through the HTTP proxy of your orcharhino Proxies, select Use HTTP proxies.

  10. In the Base URL field, enter the base URL of the Red Hat Update Infrastructure CDS node.

  11. In the Subpaths field, provide a comma-separated list of subpaths.

  12. If your alternate content source requires authentication, provide the SSL client certificate and SSL client key.

  13. If SSL verification is required, enable Verify SSL and select the SSL CA certificate.

  14. Click Add.

  15. Navigate to Content > Alternate Content Sources.

  16. Open the options menu next to the newly created alternate content source and click Refresh.

Creating an RHUI alternate content source by using Hammer CLI

You can create an RHUI alternate content source (ACS) to synchronize content from your Red Hat Update Infrastructure (RHUI) server. Leverage your existing RHUI investment and accelerate content synchronization.

orcharhino searches content paths that combine a base URL with subpaths. For example, if your base URL is https://server.example.com and your subpaths are rhel10/ and rhel9/, then orcharhino searches https://server.example.com/rhel10/ and https://server.example.com/rhel9/.

Prerequisites
Procedure

  1. On your RHUA server, display details for the required repositories:

    $ rhui-manager repo info --repo_id My_Repo_ID

    Record the relative paths from the command output to use as subpaths.

  2. Create a RHUI alternate content source:

    $ 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_orcharhino_Proxy_ID_1,My_orcharhino_Proxy_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

  3. Refresh the alternate content source:

    $ hammer alternate-content-source refresh --name "My_ACS_Name"
Verification

  • Verify that the task ran successfully:

    $ hammer task list --search "Refresh Alternate Content Source"

Permissions required to manage alternate content sources

User accounts must have a role that grants the following permissions to view and manage alternate content sources in orcharhino.

Permissions to view ACS

  • view_content_credentials

  • view_organizations

  • view_products

  • view_smart_proxies

Permissions to manage ACS

  • create_alternate_content_sources

  • destroy_alternate_content_sources

  • edit_alternate_content_sources

  • view_alternate_content_sources

The text and illustrations on this page are licensed by ATIX AG under a Creative Commons Attribution Share Alike 4.0 International ("CC BY-SA 4.0") license. This page also contains text from the official Foreman documentation which uses the same license ("CC BY-SA 4.0").