Installing orcharhino Proxy

We refer to orcharhino Server and orcharhino Proxies throughout the documentation. These terms describe the machines running your orcharhino, for example orcharhino.example.com, and their attached orcharhino Proxies, for example orcharhino-proxy.network2.example.com. Both orcharhino and orcharhino Proxy incorporate smart proxy functionality depending on their configuration.

An orcharhino Proxy allows you to manage hosts in additional networks. You can configure your orcharhino Proxy to deliver content to managed hosts by either mirroring synchronized content from your orcharhino Server or by streaming content from orcharhino Server as requested by content hosts. Your orcharhino Proxy can also function as DNS, DHCP, and TFTP server and provide CA capabilities.

The term smart proxy is used throughout the management UI. It describes the smart proxy functionality present on both your orcharhino Server and orcharhino Proxies.

When looking at the upstream documentation for Foreman and Katello, you might come across the terms smart proxy, Foreman proxy, and Katello proxy. These terms are used ambiguously to describe the software component or the attached host with smart proxy functionality in different variations. By contrast, Red Hat named their Foreman downstream product Satellite and any attached smart proxies Capsules.

Additionally, there are HTTP proxies as a way of relaying network traffic from one machine to another. They are often part of more advanced internal network architectures.

This guide describes the installation of an external orcharhino Proxy to go along with your orcharhino. If you want to use orcharhino to manage hosts in additional networks, you need an orcharhino Proxy installed in each network you want to manage. This allows you to orchestrate the process of managing hosts in different networks, that is networks spanning across different data centres and regions.

The orcharhino installation will always come bundled with internal smart proxy functionality. It is sufficient for managing hosts in the same network the orcharhino is in.

orcharhino Proxy on Windows

If you want to install orcharhino Proxy on Windows, have a look at URLs for orcharhino Proxy on Windows.

Usage Scenario

There are different reasons on why to use an orcharhino Proxy:

  • To manage infrastructure that is not part of the same network as the orcharhino.

  • To manage traffic across firewalls so as to deploy hosts into isolated networks. This helps you simplifying firewall rules and therefore making it more robust, as only the orcharhino Proxy needs to be accessible from outside its network.

  • To centrally manage infrastructure differentiated by location.

  • To reduce traffic and latency.

There are two ways on how to deliver content to managed hosts from orcharhino Proxies. An orcharhino Proxy can either mirror the synchronized content from orcharhino Server or relay requested content. This results in a trade-off between storage space and network traffic:

  • By default, orcharhino Proxies mirror the synchronized content from your orcharhino Server. Synchronized content implies that your orcharhino Proxy has a mirrored version of the content from orcharhino Server stored locally. This results in the need for additional storage capacity analogue to the orcharhino system requirements. On the other hand, there is significantly less traffic between orcharhino Proxies and your orcharhino Server.

  • Optionally, you can enable the streamed download policy for your orcharhino Proxy. orcharhino Proxies download content as requested from managed hosts without storing it locally. Instead, all content comes directly from your orcharhino Server and is purely relayed to the managed hosts in its network. This results in additional traffic between your orcharhino Server and orcharhino Proxy, but orcharhino Proxies do not need to cache the content locally using up additional disk space. For more information, see Changing the Download Policy for orcharhino Proxies.

Optionally, your orcharhino Proxy can also handle DHCP and DNS for its network.

System and Network Requirements

The orcharhino Proxy installation depends on a working orcharhino installation. It is recommended using the same operating system for orcharhino as well as for the orcharhino Proxy itself. The subscription manager needs to be installed on both machines and an activation key needs to be available.

This guide presumes a working orcharhino installation as well as a suitable host for the orcharhino Proxy. Regardless of whether it will run on virtualised hardware or on bare metal, the orcharhino Proxy machine must meet the following requirements:

Minimum Recommended

OS

Alma Linux 8, CentOS 7, Oracle Linux 7, Oracle Linux 8, Red Hat Enterprise Linux 7, Red Hat Enterprise Linux 8, or Rocky Linux 8

For more information, see OS requirements.

CPU

4 cores

8 cores

RAM

20 GiB

32 GiB

HDD 1 (/)

30 GiB

50 GiB

HDD 2 (/var)

~ 40 GiB for each Enterprise Linux distribution

~ 80 GiB for each Debian or Ubuntu distribution

~ 500 GiB (or as appropriate) if you plan to maintain additional repositories or keep multiple versions of packages

If you use streamed as download policy for your orcharhino Proxy, a second disk for /var can be as small as 10 GiB.

ATIX does not support using third party repositories on your orcharhino Server or orcharhino Proxies. Resolving package conflicts or other issues due to third party or custom repositories is not part of your orcharhino support subscription. Please contact us if you have any questions.

In addition to the system requirements, the orcharhino proxy also needs its own domain and subnet, which can be set up through orcharhino’s management UI. The network configuration and firewall rules must allow for communication from the orcharhino to the orcharhino proxy and vice versa.

For communication from the orcharhino to the orcharhino Proxy, the following ports must be open:

Port Protocol SSL Required for

80

TCP

yes

bootdisk

443

TCP

yes

Pulp

9090

TCP

yes

Querying the orcharhino proxy feature set

For communication from the orcharhino Proxy to the orcharhino, the following ports must be open:

Port Protocol SSL Required for

80

TCP

no

Anaconda, yum, Katello certificates

443

TCP

yes

yum, Katello, API, Pulp

5000

TCP

yes

Katello for Docker registry

5646

TCP

yes

Pulp mirror (Qpid dispatcher)

5647

TCP

yes

Deprecated (has been used by Qpid for Katello agent)

For communication from the clients to the orcharhino Proxy, the following ports must be open:

Port Protocol SSL Required for

53

TCP & UDP

no

DNS Services

67

UDP

no

DHCP Service

69

UDP

no

PXE boot

80

TCP

no

Anaconda, yum, templates, iPXE

443

TCP

yes

yum, Katello

5000

TCP

yes

Katello for Docker registry

5647

TCP

yes

Deprecated (has been used by Qpid for Katello agent)

8000

TCP

yes

Anaconda for downloading Kickstart templates, iPXE

8140

TCP

yes

Puppet agent to Puppet master

8443

TCP

yes

Subscription Management

9090

TCP

yes

OpenSCAP reports

The orcharhino and the orcharhino Proxy need to be reachable by name. If they are not yet resolvable through DNS, ensure to add them to each others /etc/hosts file as follows. If you are using an HTTP proxy, ensure it is properly configured as well.

This guide uses the network1 (192.168.50.0) for the orcharhino (called orcharhino), and network2 (192.168.60.0) for the orcharhino Proxy (called orcharhino-proxy). The orcharhino is the 192.168.50.10 and the orcharhino Proxy the 192.168.60.10 in the default scenario and 192.168.70.10 in network3 when opting for streamed content.

To do so, edit the etc/hosts file on both the orcharhino and the orcharhino Proxy and add the following lines:

192.168.50.10 orcharhino.network1.example.com
192.168.60.10 orcharhino-proxy.network2.example.com orcharhino-proxy

In case the orcharhino uses an HTTP proxy itself, it is necessary to add the orcharhino Proxy to the no_proxy entries.

  1. Edit the last line in /etc/sysconfig/httpd:

    no_proxy='localhost,127.0.0.1,orcharhino.network1.example.com,orcharhino,*.network1.example.com,orcharhino-proxy.network2.example.com,*.network2.example.com'

  2. Edit the last line in /etc/sysconfig/foreman-proxy:

    no_proxy='localhost,127.0.0.1,orcharhino.network1.example.com,orcharhino,*.network1.example.com,orcharhino-proxy.network2.example.com,*.network2.example.com'

  3. Edit the settings in orcharhino:

    To do so, click on Administer > Settings and edit HTTP(S) proxy except hosts:

    [ localhost, 127.0.0.1, orcharhino.network1.example.com, orcharhino, *.network1.example.com, orcharhino-proxy.network2.example.com, *.network2.example.com ]

If there are persisting problems, check your networking and firewall settings.

Preparing Content for orcharhino Proxy

There are two ways to configure the orcharhino Proxy: Either by editing the foreman-proxy-content-answers.yaml file or by passing arguments to the foreman-installer command.

An orcharhino Proxy requires the same packages as the orcharhino itself. You can get a list of repositories be running subscription-manager repos --list-enabled on your orcharhino Server. Add these repositories to products and publish them as a composite content view. This content must be available on the host you are installing the orcharhino Proxy on.

Alternatively, you can run the orcharhino Proxy Content job template. This job template runs an Ansible role on your orcharhino to automatically create the necessary content view. It bundles the required repositories and content credentials to a product specifically made for an orcharhino Proxy and creates an activation key. Run this job template on your orcharhino Server where it picks up any repositories in /etc/yum.repos.d/redhat.repo and possible HTTP proxy settings. You can synchronize the new content view by setting a variable. For more information on how to run remote execution jobs targeting orcharhino Server, see securing orcharhino.

This job template is only available if the Ansible plugin is installed.

The job template needs to be run after every orcharhino upgrade and looks as follows:

Sync content required for orcharhino Proxy using a job template

  • Select orcharhino Configuration in the Job category drop down menu (1).

  • The Job template drop down menu (2) contains the orcharhino Proxy Content job template.

  • Use the Search Query field (3) to search for your orcharhino host with the name filter.

  • The sync_repos drop down menu (4) allows you to automatically sync the required repositories after bundling them to the orcharhino Proxy Content content view.

  • The use_proxy drop down menu (5) allows you to use an HTTP proxy to connect to the repositories.

  • The use_proxy_credentials drop down menu (6) allows you to use the HTTP proxy credentials that are read from your orcharhino.

  • Click the Submit button (7) to start the execution of the job template.

Since this job template needs to be run against the orcharhino Server itself, you need to provide SSH access as described in Securing orcharhino.

This section describes the steps necessary to attach an orcharhino Proxy to your orcharhino. It consists of five steps: installing Katello, creating a .tar file containing certificates, copying the certificates to the orcharhino Proxy, installing the orcharhino Proxy, and setting the appropriate organization and location context.

Installing the orcharhino Proxy Packages

Procedure

  1. orcharhino Proxies on Alma Linux 8, Oracle Linux 8, Red Hat Enterprise Linux 8, and Rocky Linux 8 only: Enable the dnf modules on your orcharhino Proxy:

    # dnf module switch-to ruby:2.7 -y
# dnf module enable pki-core -y
# dnf module enable python36 python38 python39 -y
# subscription-manager repo-override --repo Atix_Smart_Proxy_Atix_ATIX_P_orcharhino_6_2_el8_release_R_orcharhino_orcharhino_6_2_el8_release --add module_hotfixes:1

  2. Install Katello on your orcharhino Proxy:

    • On Alma Linux 8, Oracle Linux 8, Red Hat Enterprise Linux 8, and Rocky Linux 8:

      # dnf install foreman-installer-katello

    • On CentOS 7, Oracle Linux 7, and Red Hat Enterprise Linux 7:

      # yum install foreman-installer-katello

  3. Create a tar file with certificates. In case your organization already has certificates in place, you will need the following four files on your orcharhino:

    • A private key: proxy.key

    • A certificate: proxy.cert

    • A certificate signing request: proxy.csr

    • The authority’s certificate: proxy.ca

      In case you have no certificate signing request, you may create one with the private key and certificate by running the following command:

      # openssl x509 -x509toreq -in orcharhino-proxy.cert -out orcharhino-proxy.csr -signkey orcharhino.key

      Run the following command to compile the tar file:

      # foreman-proxy-certs-generate \
    --foreman-proxy-fqdn "orcharhino-proxy.network2.example.com" \
    --certs-tar "/root/orcharhino-proxy.network2.example.com-certs.tar" \
    --server-cert /root/certs/orcharhino-proxy.cert \
    --server-cert-req /root/certs/orcharhino-proxy.csr \
    --server-key /root/certs/orcharhino-proxy.key \
    --server-ca-cert /root/certs/orcharhino-proxy.ca

      In case there are no existing certificates, you can create them by running the following command on your orcharhino:

      # foreman-proxy-certs-generate \
    --foreman-proxy-fqdn "orcharhino-proxy.network2.example.com" \
    --certs-tar "orcharhino-proxy.network2.example.com-certs.tar"

      Save the standard output describing how to import certificates. This helps later on when installing the orcharhino Proxy.

  4. Copy the generated certificates from your orcharhino Server to your orcharhino Proxy. This allows for a secure certificate based connection:

    # scp /root/orcharhino-proxy.network2.example.com-certs.tar root@orcharhino-proxy.network2.example.com:/root/orcharhino-proxy.network2.example.com-certs.tar

  5. Install orcharhino Proxy with the proper certificates:

    # foreman-installer \
    --scenario foreman-proxy-content \
    --certs-tar-file                              "/root/orcharhino-proxy.network2.example.com-certs.tar" \
    --foreman-proxy-content-parent-fqdn           "orcharhino.network1.example.com" \
    --foreman-proxy-register-in-foreman           "true" \
    --foreman-proxy-foreman-base-url              "https://orcharhino.network1.example.com" \
    --foreman-proxy-trusted-hosts                 "orcharhino.network1.example.com" \
    --foreman-proxy-trusted-hosts                 "orcharhino-proxy.network2.example.com" \
    --foreman-proxy-oauth-consumer-key            "mGZxEukJVvdL89ySA6Ymk3bAuGSF7jJj" \
    --foreman-proxy-oauth-consumer-secret         "g2tNnBR7qNHg9Gptt4XMcsFnh9c3kDSg" \
    --puppet-server-foreman-url                   "https://orcharhino.network1.example.com"

  6. Set the organization and location context.

    To add the organization and location to the orcharhino Proxy, go to Infrastructure > Smart Proxies and select orcharhino-proxy.network2.example.com.

    • Add Organization: your organization

    • Add Location: your location

    • Add Lifecycle Environment: Production

    • Download Policy: Immediate

      One way to distinguish between orcharhino administrators and regular users is to place your orcharhino Server and any attached orcharhino Proxies into a separate location and/or organization context.

      Alternatively, you can achieve a fine grained permissions concept using roles and filters.

  7. If you want to manage hosts running Debian or Ubuntu through your orcharhino Proxy, copy the public pulp_deb_signing.key key from orcharhino Server to your orcharhino Proxy:

    # scp /var/www/html/pub/pulp_deb_signing.key root@orcharhino-proxy.network2.example.com:/var/www/html/pub/pulp_deb_signing.key

By now, you have a fully functional orcharhino Proxy. Optionally, you can now activate DHCP and DNS services on your orcharhino Proxy.

Optional: Installing Puppet on orcharhino Proxies

Puppet is an optional plugin for orcharhino Server and orcharhino Proxies. If you use Puppet to configure hosts, you need to install the Puppet plugin on your orcharhino Proxies.

Procedure

  1. Connect to your orcharhino Proxy using SSH:

    # ssh root@orcharhino-proxy.network2.example.com

  2. Rerun the foreman-installer to enable the Puppet plugin:

    # foreman-installer \
--foreman-proxy-puppet true \
--foreman-proxy-puppetca true

Optional: Removing Puppet on orcharhino Proxies

Puppet is an optional plugin for orcharhino Server and orcharhino Proxies. If you do not use Puppet to configure hosts, you can remove the Puppet plugin from your orcharhino Proxies.

Prerequisite

  • You can only remove the Puppet plugin if it is installed on your orcharhino Proxy.

Procedure

  1. Connect to your orcharhino Proxy using SSH:

    # ssh root@orcharhino-proxy.network2.example.com

  2. Rerun the foreman-installer to disable the Puppet plugin:

    # foreman-installer \
--foreman-proxy-puppet false \
--foreman-proxy-puppetca false

Changing the Download Policy for orcharhino Proxies

There are four ways on how orcharhino Proxies handle the download of content from the orcharhino Server.

  • Immediate: Synchronize content immediately from orcharhino Server onto orcharhino Proxies.

  • On Demand: Download content at time of request by a managed host onto orcharhino Proxies.

  • Inherit from Repository: Synchronize content as specified on a per-repository basis onto orcharhino Proxies.

  • Streamed: Relay content requested by content hosts from orcharhino Server without saving it on orcharhino Proxies.

Procedure

  1. Navigate to Infrastructure > Smart Proxies.

  2. Select an orcharhino Proxy and click Edit.

  3. On the Smart Proxy tab, adjust the Download Policy.

  4. Click Submit to save your changes.

Depending on your setting of Sync Smart Proxies after Content View promotion, content is automatically synchronized to orcharhino Proxies after promoting a content view. Alternatively, you can manually synchronize content from orcharhino Server to orcharhino Proxies:

Procedure

  1. Navigate to Infrastructure > Smart Proxies.

  2. Select your orcharhino Proxy.

  3. On the Overview tab, click Synchronize.

    • Select Optimized Sync to bypass any unnecessary synchronization steps.

    • Select Complete Sync to synchronize repositories even if the meta data appears to be unchanged.

Optional: Activating DHCP, DNS, and TFTP

We generally recommend having the orcharhino Proxy provide DHCP, DNS, and TFTP services on its respective network.

This subsection describes the steps necessary to activate DHCP, DNS, and TFTP on the orcharhino Proxy. First, TFTP capabilities are enabled on the orcharhino Proxy using the following command:

# foreman-installer --foreman-proxy-tftp true

This activates TFTP capabilities on your orcharhino proxy which is necessary for provisioning hosts using PXE.

To activate DHCP and DNS on your orcharhino Proxy, configure /etc/foreman-installer/scenarios.d/foreman-proxy-content-answers.yaml. Active DHCP and DNS simultaneously. This is a sample configuration:

#DHCP:
dhcp: true
dhcp_gateway: 192.168.60.254
dhcp_range: 192.168.60.50 192.168.60.200
dhcp_option_domain: network2.example.com

#DNS:
dns: true
dns_zone: network2.example.com
dns_reverse:
- 60.168.192.in-addr.arpa
dns_forwarder:
- 192.168.50.10

Rerun the foreman-installer to automatically fetch the configuration from the edited yaml file. After that, the orcharhino Proxy can be set up as DHCP and DNS server in the corresponding subnet and domain.

Navigate to Infrastructure > Domains and select network2.example.com. Select the new orcharhino Proxy orcharhino-proxy.network2.example.com.

On Infrastructure > Subnets, select vlan60 and change the primary DNS to 192.168.60.10 with IPAM to DHCP and Boot Mode to DHCP. Under Proxies, set everything but the last to orcharhino-proxy.network2.example.com.

Optional: Activating Remote Execution via SSH

On orcharhino, the remote execution plugin is installed by default. It can be installed on orcharhino proxies as follows:

  1. Run the following command on the orcharhino Proxy to install this plugin:

    foreman-installer --enable-foreman-proxy-plugin-remote-execution-ssh

  2. Next, navigate to Infrastructure > Subnets and select the subnet of the orcharhino Proxy.

  3. On the Remove Execution tab, activate the orcharhino Proxy and click the Submit button.

  4. You can now schedule remote jobs on hosts in the subnet of the orcharhino Proxy.

Optional: Installing orcharhino Debug

You can collect information about your orcharhino Proxy using orcharhino-debug analogue to your orcharhino Server.

Procedure

  1. Connect to your orcharhino Proxy using SSH:

    # ssh root@orcharhino-proxy.network2.example.com

  2. Install the orcharhino helper package.

    • On Alma Linux 8, Oracle Linux 8, Red Hat Enterprise Linux 8, and Rocky Linux 8:

      # dnf install orcharhino-helper

    • On CentOS 7, Oracle Linux 7, and Red Hat Enterprise Linux 7:

      # yum install orcharhino-helper

  3. Optional: Verify the installation:

    # orcharhino-debug -h

Managing DHCP Using orcharhino Proxy

orcharhino can integrate with a DHCP service using your orcharhino Proxy. A orcharhino Proxy has multiple DHCP providers that you can use to integrate orcharhino with your existing DHCP infrastructure or deploy a new one. You can use the DHCP module of orcharhino Proxy to query for available IP addresses, add new, and delete existing reservations. Note that your orcharhino Proxy cannot manage subnet declarations.

Available DHCP providers

Configuring dhcp_libvirt

The dhcp_libvirt plugin manages IP reservations and leases using dnsmasq through the libvirt API. It uses ruby-libvirt to connect to the local or remote instance of libvirt daemon.

Procedure

  • You can use foreman-installer to configure dhcp_libvirt:

    foreman-installer \
--foreman-proxy-dhcp true \
--foreman-proxy-dhcp-provider libvirt \
--foreman-proxy-libvirt-network default \
--foreman-proxy-libvirt-network qemu:///system

dhcp_isc Settings

The dhcp_isc provider uses a combination of the ISC DHCP server OMAPI management interface and parsing of configuration and lease files. This requires it to be run on the same host as the DHCP server. The following settings are defined in dhcp_isc.yml:

Configuring the path to the config and leases files:
:config: /etc/dhcp/dhcpd.conf
:leases: /var/lib/dhcpd/dhcpd.leases
Securing the DHCP server with an omapi_key
:key_name: My_OMAPI_Key
:key_secret: My_Key_Secret
Setting a port on which the DHCP server listens
:omapi_port: My_DHCP_Server_Port  # default: 7911

The server is defined in dhcp.yml:

Setting the host on which the DHCP server runs on
:server: My_DHCP_Server_FQDN

DHCP Options for Network Configuration

--foreman-proxy-dhcp

Enables the DHCP service. You can set this option to true or false.

--foreman-proxy-dhcp-managed

Enables Foreman to manage the DHCP service. You can set this option to true or false.

--foreman-proxy-dhcp-gateway

The DHCP pool gateway. Set this to the address of the external gateway for hosts on your private network.

--foreman-proxy-dhcp-interface

Sets the interface for the DHCP service to listen for requests. Set this to eth1.

--foreman-proxy-dhcp-nameservers

Sets the addresses of the nameservers provided to clients through DHCP. Set this to the address for orcharhino Server on eth1.

--foreman-proxy-dhcp-range

A space-separated DHCP pool range for Discovered and Unmanaged services.

--foreman-proxy-dhcp-server

Sets the address of the DHCP server to manage.

--foreman-proxy-dhcp-subnets

Sets the subnets of the DHCP server to manage. Example: --foreman-proxy-dhcp-subnets 192.168.205.0/255.255.255.128 or --foreman-proxy-dhcp-subnets 192.168.205.128/255.255.255.128

Run foreman-installer --help to view more options related to DHCP and other orcharhino Proxy services.

Securing the dhcpd API

orcharhino Proxy interacts with DHCP daemon using the dhcpd API to manage DHCP. By default, the dhcpd API listens to any host without access control. You can add an omapi_key to provide basic security.

Procedure

  1. Install the required packages:

    # yum install install bind-utils

  2. Generate a key:

    # dnssec-keygen -r /dev/urandom -a HMAC-MD5 -b 512 -n HOST omapi_key
# cat Komapi_key.+*.private | grep ^Key|cut -d ' ' -f2-

  3. Use foreman-installer to secure the dhcpd API:

    # foreman-installer \
--foreman-proxy-dhcp-key-name "My_Name" \
--foreman-proxy-dhcp-key-secret "My_Secret"

Managing DNS Using orcharhino Proxy

orcharhino can manage DNS records using your orcharhino Proxy. DNS management contains updating and removing DNS records from existing DNS zones. A orcharhino Proxy has multiple DNS providers that you can use to integrate orcharhino with your existing DNS infrastructure or deploy a new one.

After you have enabled DNS, your orcharhino Proxy can manipulate any DNS server that complies with RFC 2136 using the dns_nsupdate provider. Other providers provide more direct integration, such as dns_infoblox for Infoblox.

Available DNS Providers

Configuring dns_libvirt

The dns_libvirt DNS provider manages DNS records using dnsmasq through the libvirt API. It uses ruby-libvirt gem to connect to the local or a remote instance of libvirt daemon.

Procedure

  • You can use foreman-installer to configure dns_libvirt:

    # foreman-installer \
--foreman-proxy-dns true \
--foreman-proxy-dns-provider libvirt \
--foreman-proxy-libvirt-network default \
--foreman-proxy-libvirt-url qemu:///system

    Note that you can only use one network and URL for both dns_libvirt and dhcp_libvirt.

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