1. Preparing your environment for installation

Before you install orcharhino, ensure that your environment meets the following requirements.

1.1. System requirements

The following requirements apply to the networked base operating system:

  • x86_64 architecture

  • 4-core 2.0 GHz CPU at a minimum

  • A minimum of 20 GB RAM is required for orcharhino Server to function. orcharhino running with less RAM than the minimum value might not operate correctly.

  • Administrative user (root) access

  • Full forward and reverse DNS resolution using a fully-qualified domain name

orcharhino only supports UTF-8 encoding. If your territory is USA and your language is English, set en_US.utf-8 as the system-wide locale settings. For more information about configuring system locale in Enterprise Linux, see Configuring the system locale.

orcharhino Server and orcharhino Proxy do not support shortnames in the hostnames. When using custom certificates, the Common Name (CN) of the custom certificate must be a fully qualified domain name (FQDN) instead of a shortname. This does not apply to the clients of a orcharhino.

Before you install orcharhino Server, ensure that your environment meets the requirements for installation.

orcharhino Server must be installed on a freshly provisioned system that serves no other function except to run orcharhino Server. The freshly provisioned system must not have the following users provided by external identity providers to avoid conflicts with the local users that orcharhino Server creates:

  • apache

  • foreman

  • foreman-proxy

  • postgres

  • pulp

  • puppet

  • redis

  • tomcat

Synchronized system clock

The system clock on the base operating system where you are installing your orcharhino Server must be synchronized across the network. If the system clock is not synchronized, SSL certificate verification might fail.

1.2. Storage requirements

The following table details storage requirements for specific directories. These values are based on expected use case scenarios and can vary according to individual environments.

Table 1. Storage requirements for a orcharhino Server installation
Directory Installation Size Runtime Size

/var/log

10 MB

10 GB

/var/lib/pgsql

100 MB

20 GB

/usr

10 GB

Not Applicable

/opt/puppetlabs

500 MB

Not Applicable

/var/lib/pulp

1 MB

300 GB

1.3. Supported operating systems

The following operating systems are supported by the installer, have packages, and are tested for deploying orcharhino:

Table 2. Operating systems supported by foreman-installer

Operating System

Architecture

Notes

Enterprise Linux 9

x86_64 only

EPEL is not supported.

Enterprise Linux 8

x86_64 only

EPEL is not supported.

ATIX AG advises against using an existing system because the orcharhino installer will affect the configuration of several components.

1.4. Supported browsers

The orcharhino management UI and command-line interface is translated into various languages.

1.5. Port and firewall requirements

For the components of orcharhino architecture to communicate, ensure that the required network ports are open and free on the base operating system. You must also ensure that the required network ports are open on any network-based firewalls.

Use this information to configure any network-based firewalls. Note that some cloud solutions must be specifically configured to allow communications between machines because they isolate machines similarly to network-based firewalls. If you use an application-based firewall, ensure that the application-based firewall permits all applications that are listed in the tables and known to your firewall. If possible, disable the application checking and allow open port communication based on the protocol.

Integrated orcharhino Proxy

orcharhino Server has an integrated orcharhino Proxy and any host that is directly connected to orcharhino Server is a Client of orcharhino in the context of this section. This includes the base operating system on which orcharhino Proxy is running.

Clients of orcharhino Proxy

Hosts which are clients of orcharhino Proxies, other than orcharhino’s integrated orcharhino Proxy, do not need access to orcharhino Server.

Required ports can change based on your configuration.

The following tables indicate the destination port and the direction of network traffic:

Table 3. orcharhino Server incoming traffic
Destination Port Protocol Service Source Required For Description

53

TCP and UDP

DNS

DNS Servers and clients

Name resolution

DNS (optional)

67

UDP

DHCP

Client

Dynamic IP

DHCP (optional)

69

UDP

TFTP

Client

TFTP Server (optional)

443

TCP

HTTPS

orcharhino Proxy

orcharhino API

Communication from orcharhino Proxy

443, 80

TCP

HTTPS, HTTP

Client

Global Registration

Registering hosts to orcharhino

Port 443 is required for registration initiation, uploading facts, and sending installed packages and traces

Port 80 notifies orcharhino on the /unattended/built endpoint that registration has finished

443

TCP

HTTPS

orcharhino

Content Mirroring

Management

443

TCP

HTTPS

orcharhino

orcharhino Proxy API

Smart Proxy functionality

443, 80

TCP

HTTPS, HTTP

orcharhino Proxy

Content Retrieval

Content

443, 80

TCP

HTTPS, HTTP

Client

Content Retrieval

Content

1883

TCP

MQTT

Client

Pull based REX (optional)

Content hosts for REX job notification (optional)

5910 – 5930

TCP

HTTPS

Browsers

Compute Resource’s virtual console

8000

TCP

HTTP

Client

Provisioning templates

Template retrieval for client installers, iPXE or UEFI HTTP Boot

8000

TCP

HTTPS

Client

PXE Boot

Installation

8140

TCP

HTTPS

Client

Puppet agent

Client updates (optional)

9090

TCP

HTTPS

orcharhino

orcharhino Proxy API

Smart Proxy functionality

9090

TCP

HTTPS

Client

OpenSCAP

Configure Client (if the OpenSCAP plugin is installed)

9090

TCP

HTTPS

Discovered Node

Discovery

Host discovery and provisioning (if the discovery plugin is installed)

9090

TCP

HTTPS

Client

Pull based REX (optional)

Content hosts for REX job notification (optional)

Any host that is directly connected to orcharhino Server is a client in this context because it is a client of the integrated orcharhino Proxy. This includes the base operating system on which a orcharhino Proxy is running.

A DHCP orcharhino Proxy performs ICMP ping or TCP echo connection attempts to hosts in subnets with DHCP IPAM set to find out if an IP address considered for use is free. This behavior can be turned off using foreman-installer --foreman-proxy-dhcp-ping-free-ip=false.

Note

Some outgoing traffic returns to orcharhino to enable internal communication and security operations.

Table 4. orcharhino Server outgoing traffic
Destination Port Protocol Service Destination Required For Description

ICMP

ping

Client

DHCP

Free IP checking (optional)

7

TCP

echo

Client

DHCP

Free IP checking (optional)

22

TCP

SSH

Target host

Remote execution

Run jobs

22, 16514

TCP

SSH SSH/TLS

Compute Resource

orcharhino originated communications, for compute resources in libvirt

53

TCP and UDP

DNS

DNS Servers on the Internet

DNS Server

Resolve DNS records (optional)

53

TCP and UDP

DNS

DNS Server

orcharhino Proxy DNS

Validation of DNS conflicts (optional)

53

TCP and UDP

DNS

DNS Server

Orchestration

Validation of DNS conflicts

68

UDP

DHCP

Client

Dynamic IP

DHCP (optional)

80

TCP

HTTP

Remote repository

Content Sync

Remote repositories

389, 636

TCP

LDAP, LDAPS

External LDAP Server

LDAP

LDAP authentication, necessary only if external authentication is enabled. The port can be customized when LDAPAuthSource is defined

443

TCP

HTTPS

orcharhino

orcharhino Proxy

orcharhino Proxy

Configuration management

Template retrieval

OpenSCAP

Remote Execution result upload

443

TCP

HTTPS

Amazon EC2, Azure, Google GCE

Compute resources

Virtual machine interactions (query/create/destroy) (optional)

443

TCP

HTTPS

orcharhino Proxy

Content mirroring

Initiation

443

TCP

HTTPS

Infoblox DHCP Server

DHCP management

When using Infoblox for DHCP, management of the DHCP leases (optional)

623

Client

Power management

BMC On/Off/Cycle/Status

5000

TCP

HTTPS

OpenStack Compute Resource

Compute resources

Virtual machine interactions (query/create/destroy) (optional)

5900 – 5930

TCP

SSL/TLS

Hypervisor

noVNC console

Launch noVNC console

5985

TCP

HTTP

Client

WinRM

Configure Client running Windows

5986

TCP

HTTPS

Client

WinRM

Configure Client running Windows

7911

TCP

DHCP, OMAPI

DHCP Server

DHCP

The DHCP target is configured using --foreman-proxy-dhcp-server and defaults to localhost

ISC and remote_isc use a configurable port that defaults to 7911 and uses OMAPI

8443

TCP

HTTPS

Client

Discovery

orcharhino Proxy sends reboot command to the discovered host (optional)

9090

TCP

HTTPS

orcharhino Proxy

orcharhino Proxy API

Management of orcharhino Proxies

1.6. Enabling connections from a client to orcharhino Server

orcharhino Proxies and Content Hosts that are clients of a orcharhino Server’s internal orcharhino Proxy require access through orcharhino’s host-based firewall and any network-based firewalls.

Use this procedure to configure the host-based firewall on the system that orcharhino is installed on, to enable incoming connections from Clients, and to make the configuration persistent across system reboots. For more information on the ports used, see Port and firewall requirements in Installing orcharhino Server.

Procedure
  1. Open the ports for clients on orcharhino Server:

    # firewall-cmd \
    --add-port="8000/tcp" \
    --add-port="9090/tcp"
  2. Allow access to services on orcharhino Server:

    # firewall-cmd \
    --add-service=dns \
    --add-service=dhcp \
    --add-service=tftp \
    --add-service=http \
    --add-service=https \
    --add-service=puppetmaster
  3. Make the changes persistent:

    # firewall-cmd --runtime-to-permanent
Verification
  • Enter the following command:

    # firewall-cmd --list-all

For more information, see Using and configuring firewalld in Red Hat Enterprise Linux 9 guide or Using and configuring firewalld in Red Hat Enterprise Linux 8 guide.

1.7. Verifying DNS resolution

Verify the full forward and reverse DNS resolution using a fully-qualified domain name to prevent issues while installing orcharhino.

Procedure
  1. Ensure that the host name and local host resolve correctly:

    # ping -c1 localhost
    # ping -c1 `hostname -f` # my_system.domain.com

    Successful name resolution results in output similar to the following:

    # ping -c1 localhost
    PING localhost (127.0.0.1) 56(84) bytes of data.
    64 bytes from localhost (127.0.0.1): icmp_seq=1 ttl=64 time=0.043 ms
    
    --- localhost ping statistics ---
    1 packets transmitted, 1 received, 0% packet loss, time 0ms
    rtt min/avg/max/mdev = 0.043/0.043/0.043/0.000 ms
    
    # ping -c1 `hostname -f`
    PING hostname.gateway (XX.XX.XX.XX) 56(84) bytes of data.
    64 bytes from hostname.gateway (XX.XX.XX.XX): icmp_seq=1 ttl=64 time=0.019 ms
    
    --- localhost.gateway ping statistics ---
    1 packets transmitted, 1 received, 0% packet loss, time 0ms
    rtt min/avg/max/mdev = 0.019/0.019/0.019/0.000 ms
  2. To avoid discrepancies with static and transient host names, set all the host names on the system by entering the following command:

    # hostnamectl set-hostname name
Warning

Name resolution is critical to the operation of orcharhino. If orcharhino cannot properly resolve its fully qualified domain name, tasks such as content management, subscription management, and provisioning will fail.

1.8. Tuning orcharhino Server with predefined profiles

If your orcharhino deployment includes more than 5000 hosts, you can use predefined tuning profiles to improve performance of orcharhino.

Note that you cannot use tuning profiles on orcharhino Proxies.

You can choose one of the profiles depending on the number of hosts your orcharhino manages and available hardware resources.

The tuning profiles are available in the /usr/share/foreman-installer/config/foreman.hiera/tuning/sizes directory.

When you run the foreman-installer command with the --tuning option, deployment configuration settings are applied to orcharhino in the following order:

  1. The default tuning profile defined in the /usr/share/foreman-installer/config/foreman.hiera/tuning/common.yaml file

  2. The tuning profile that you want to apply to your deployment and is defined in the /usr/share/foreman-installer/config/foreman.hiera/tuning/sizes/ directory

  3. Optional: If you have configured a /etc/foreman-installer/custom-hiera.yaml file, orcharhino applies these configuration settings.

Note that the configuration settings that are defined in the /etc/foreman-installer/custom-hiera.yaml file override the configuration settings that are defined in the tuning profiles.

Therefore, before applying a tuning profile, you must compare the configuration settings that are defined in the default tuning profile in /usr/share/foreman-installer/config/foreman.hiera/tuning/common.yaml, the tuning profile that you want to apply and your /etc/foreman-installer/custom-hiera.yaml file, and remove any duplicated configuration from the /etc/foreman-installer/custom-hiera.yaml file.

default

Number of hosts: 0 – 5000

RAM: 20G

Number of CPU cores: 4

medium

Number of hosts: 5001 – 10000

RAM: 32G

Number of CPU cores: 8

large

Number of hosts: 10001 – 20000

RAM: 64G

Number of CPU cores: 16

extra-large

Number of hosts: 20001 – 60000

RAM: 128G

Number of CPU cores: 32

extra-extra-large

Number of hosts: 60000+

RAM: 256G

Number of CPU cores: 48+

Procedure
  1. Optional: If you have configured the custom-hiera.yaml file on orcharhino Server, back up the /etc/foreman-installer/custom-hiera.yaml file to custom-hiera.original. You can use the backup file to restore the /etc/foreman-installer/custom-hiera.yaml file to its original state if it becomes corrupted:

    # cp /etc/foreman-installer/custom-hiera.yaml \
    /etc/foreman-installer/custom-hiera.original
  2. Optional: If you have configured the custom-hiera.yaml file on orcharhino Server, review the definitions of the default tuning profile in /usr/share/foreman-installer/config/foreman.hiera/tuning/common.yaml and the tuning profile that you want to apply in /usr/share/foreman-installer/config/foreman.hiera/tuning/sizes/. Compare the configuration entries against the entries in your /etc/foreman-installer/custom-hiera.yaml file and remove any duplicated configuration settings in your /etc/foreman-installer/custom-hiera.yaml file.

  3. Enter the foreman-installer command with the --tuning option for the profile that you want to apply. For example, to apply the medium tuning profile settings, enter the following command:

    # foreman-installer --tuning medium

1.9. Requirements for installation in an IPv4 network

The following requirements apply to installations in an IPv4 network:

  • An IPv6 loopback must be configured on the base system. The loopback is typically configured by default. Do not disable it.

  • Do not disable IPv6 in kernel by adding the ipv6.disable=1 kernel parameter.

2. Preparing your environment for orcharhino installation in an IPv6 network

You can install and use orcharhino in an IPv6 network. Before installing orcharhino in an IPv6 network, view the limitations and ensure that you meet the requirements.

To provision hosts in an IPv6 network, after installing orcharhino, you must also configure orcharhino for the UEFI HTTP boot provisioning. For more information, see Configuring orcharhino for UEFI HTTP boot provisioning in an IPv6 network.

2.1. Limitations of orcharhino installation in an IPv6 network

orcharhino installation in an IPv6 network has the following limitations:

  • You can install orcharhino and orcharhino Proxies in IPv6-only systems, dual-stack installation is not supported.

  • Although orcharhino provisioning templates include IPv6 support for PXE and HTTP (iPXE) provisioning, the only tested and certified provisioning workflow is the UEFI HTTP Boot provisioning. This limitation only relates to users who plan to use orcharhino to provision hosts.

  • orcharhino does not support configuring an HTTP proxy using a direct IPv6 address. Instead, configure the HTTP proxy with a FQDN that resolves to the IPv6 address. Using an IPv6 address as the HTTP proxy URL causes it to fail.

2.2. Requirements for orcharhino installation in an IPv6 network

Before installing orcharhino in an IPv6 network, ensure that you meet the following requirements:

  • You must deploy an external DHCP IPv6 server as a separate unmanaged service to bootstrap clients into GRUB2, which then configures IPv6 networking either using DHCPv6 or assigning static IPv6 address. This is required because the DHCP server in Red Hat Enterprise Linux (ISC DHCP) does not provide an integration API for managing IPv6 records, therefore the orcharhino Proxy DHCP plugin that provides DHCP management is limited to IPv4 subnets.

  • Optional: If you rely on content from IPv4 networks, you must deploy an external IPv4 HTTP proxy server. This is required to access Content Delivery Networks that distribute content only over IPv4 networks, therefore you must use this proxy to pull content into orcharhino on your IPv6 network.

  • You must configure orcharhino to use this dual stack (supporting both IPv4 and IPv6) HTTP proxy server as the default proxy. For more information, see Adding a Default HTTP Proxy to orcharhino.

3. Installing orcharhino Server

Use the following procedures to install orcharhino Server and perform the initial configuration.

Note that the orcharhino installation script is based on Puppet, which means that if you run the installation script more than once, it might overwrite any manual configuration changes. ⁠ To avoid this and determine which future changes apply, use the --noop argument when you run the installation script. This argument ensures that no actual changes are made. Potential changes are written to /var/log/foreman-installer/katello.log.

Files are always backed up and so you can revert any unwanted changes. For example, in the foreman-installer logs, you can see an entry similar to the following about Filebucket:

/Stage[main]/Dhcp/File[/etc/dhcp/dhcpd.conf]: Filebucketed /etc/dhcp/dhcpd.conf to puppet with sum 622d9820b8e764ab124367c68f5fa3a1

You can restore the previous file as follows:

# puppet filebucket -l \
restore /etc/dhcp/dhcpd.conf 622d9820b8e764ab124367c68f5fa3a1

3.1. Configuring the HTTP proxy to connect to Red Hat CDN

Prerequisites

Your network gateway and the HTTP proxy must allow access to the following hosts:

Host name Port Protocol

subscription.rhsm.redhat.com

443

HTTPS

cdn.redhat.com

443

HTTPS

For more information, see Registering orcharhino Server to OCC in the ATIX Service Portal.

orcharhino Server uses SSL to communicate with the Red Hat CDN securely. An SSL interception proxy interferes with this communication. These hosts must be allowlisted on your HTTP proxy.

For a list of IP addresses used by the Red Hat CDN (cdn.redhat.com), see the Knowledgebase article Public CIDR Lists for Red Hat on the Red Hat Customer Portal.

To configure the Subscription Manager with the HTTP proxy, follow the procedure below.

Procedure
  1. On orcharhino Server, complete the following details in the /etc/rhsm/rhsm.conf file:

    # an http proxy server to use (enter server FQDN)
    proxy_hostname = myproxy.example.com
    
    # port for http proxy server
    proxy_port = 8080
    
    # user name for authenticating to an http proxy, if needed
    proxy_user =
    
    # password for basic http proxy auth, if needed
    proxy_password =

3.2. Configuring repositories

Ensure the repositories required to install orcharhino Server are enabled on your Enterprise Linux host.

3.3. Optional: Using fapolicyd on orcharhino Server

By enabling fapolicyd on your orcharhino Server, you can provide an additional layer of security by monitoring and controlling access to files and directories. The fapolicyd daemon uses the RPM database as a repository of trusted binaries and scripts.

You can turn on or off the fapolicyd on your orcharhino Server or orcharhino Proxy at any point.

3.3.1. Installing fapolicyd on orcharhino Server

You can install fapolicyd along with orcharhino Server or can be installed on an existing orcharhino Server. If you are installing fapolicyd along with the new orcharhino Server, the installation process will detect the fapolicyd in your Enterprise Linux host and deploy the orcharhino Server rules automatically.

Prerequisites
  • Ensure your host has access to the BaseOS repositories of Enterprise Linux.

Procedure
  1. For a new installation, install fapolicyd:

    # dnf install fapolicyd
  2. For an existing installation, install fapolicyd using dnf install:

    # dnf install fapolicyd
  3. Start the fapolicyd service:

    # systemctl enable --now fapolicyd
Verification
  • Verify that the fapolicyd service is running correctly:

    # systemctl status fapolicyd
New orcharhino Server or orcharhino Proxy installations

In case of new orcharhino Server or orcharhino Proxy installation, follow the standard installation procedures after installing and enabling fapolicyd on your Enterprise Linux host.

Additional resources

For more information on fapolicyd, see Blocking and allowing applications using fapolicyd in Red Hat Enterprise Linux 9 guide or Blocking and allowing applications using fapolicyd in Red Hat Enterprise Linux 8 guide.

3.4. Installing orcharhino Server packages

3.5. Configuring orcharhino Server

Procedure

Install orcharhino Server using the foreman-installer installation script.

This method is performed by running the installation script with one or more command options. The command options override the corresponding default initial configuration options and are recorded in the orcharhino answer file. You can run the script as often as needed to configure any necessary options.

3.5.1. Configuring orcharhino installation

This initial configuration procedure creates an organization, location, user name, and password. After the initial configuration, you can create additional organizations and locations if required. The initial configuration also installs PostgreSQL databases on the same server.

The installation process can take tens of minutes to complete. If you are connecting remotely to the system, use a utility such as tmux that allows suspending and reattaching a communication session so that you can check the installation progress in case you become disconnected from the remote system. If you lose connection to the shell where the installation command is running, see the log at /var/log/foreman-installer/katello.log to determine if the process completed successfully.

Considerations
  • Use the foreman-installer --scenario katello --help command to display the most commonly used options and any default values.

  • Use the foreman-installer --scenario katello --full-help command to display advanced options.

  • Specify a meaningful value for the option: --foreman-initial-organization. This can be your company name. An internal label that matches the value is also created and cannot be changed afterwards. If you do not specify a value, an organization called Default Organization with the label Default_Organization is created. You can rename the organization name but not the label.

  • By default, all configuration files configured by the installer are managed. When foreman-installer runs, it overwrites any manual changes to the managed files with the intended values. This means that running the installer on a broken system should restore it to working order, regardless of changes made. For more information on how to apply custom configuration on other services, see Applying Custom Configuration to orcharhino.

Procedure
  1. Enter the following command with any additional options that you want to use:

    # foreman-installer --scenario katello \
    --foreman-initial-organization "My_Organization" \
    --foreman-initial-location "My_Location" \
    --foreman-initial-admin-username admin_user_name \
    --foreman-initial-admin-password admin_password

    The script displays its progress and writes logs to /var/log/foreman-installer/katello.log.

4. Performing additional configuration on orcharhino Server

4.1. Configuring orcharhino Server to consume content from a custom CDN

If you have an internal Content Delivery Network (CDN) or serve content on an accessible web server, you can configure your orcharhino Server to consume Red Hat repositories from this CDN server instead of the Red Hat CDN. A CDN server can be any web server that mirrors repositories in the same directory structure as the Red Hat CDN.

You can configure the source of content for each organization. orcharhino recognizes automatically which Red Hat repositories from the subscription manifest in your organization are available on your CDN server.

Prerequisites
  • You have a CDN server that provides Red Hat content and is accessible by orcharhino Server.

  • If your CDN server uses HTTPS, ensure you have uploaded the SSL certificate into orcharhino. For more information, see Importing Custom SSL Certificates in Managing content.

  • You have uploaded a manifest to your organization.

Procedure
  1. In the orcharhino management UI, navigate to Content > Subscriptions.

  2. Click Manage Manifest.

  3. Select the CDN Configuration tab.

  4. Select the Custom CDN tab.

  5. In the URL field, enter the URL of your CDN server from which you want orcharhino Server to consume Red Hat repositories.

  6. Optional: In the SSL CA Content Credential, select the SSL certificate of the CDN server.

  7. Click Update.

  8. You can now enable Red Hat repositories consumed from your internal CDN server.

CLI procedure
  1. Connect to your orcharhino Server using SSH.

  2. Set CDN configuration to your custom CDN server:

    # hammer organization configure-cdn --name="My_Organization" \
    --type=custom_cdn \
    --url https://my-cdn.example.com \
    --ssl-ca-credential-id "My_CDN_CA_Cert_ID"
Additional resources

4.2. Configuring orcharhino for UEFI HTTP boot provisioning in an IPv6 network

Use this procedure to configure orcharhino to provision hosts in an IPv6 network with UEFI HTTP Boot provisioning.

Prerequisites
  • Ensure that your clients can access DHCP and HTTP servers.

  • Ensure that the UDP ports 67 and 68 are accessible by clients so clients can send DHCP requests and receive DHCP offers.

  • Ensure that the TCP port 8000 is open for clients to download files and Kickstart templates from orcharhino and orcharhino Proxies.

  • Ensure that the host provisioning interface subnet has an HTTP Boot orcharhino Proxy, and Templates orcharhino Proxy set. For more information, see Adding a Subnet to orcharhino Server in Provisioning hosts.

  • In the orcharhino management UI, navigate to Administer > Settings > Provisioning and ensure that the Token duration setting is not set to 0. orcharhino cannot identify clients that are booting from the network by a remote IPv6 address because of unmanaged DHCPv6 service, therefore provisioning tokens must be enabled.

Procedure
  1. You must disable DHCP management in the installer or not use it.

  2. For all IPv6 subnets created in orcharhino, set the DHCP orcharhino Proxy to blank.

  3. Optional: If the host and the DHCP server are separated by a router, configure the DHCP relay agent and point to the DHCP server.

  4. On orcharhino or orcharhino Proxy from which you provision, update the grub2-efi package to the latest version:

    # dnf upgrade grub2-efi

4.3. Configuring orcharhino Server with an HTTP proxy

Use the following procedures to configure orcharhino with an HTTP proxy.

4.3.1. Adding a default HTTP proxy to orcharhino

If your network uses an HTTP Proxy, you can configure orcharhino Server to use an HTTP proxy for requests to the Red Hat Content Delivery Network (CDN) or another content source. Use the FQDN instead of the IP address where possible to avoid losing connectivity because of network changes.

The following procedure configures a proxy only for downloading content for orcharhino. To use the CLI instead of the orcharhino management UI, see the CLI procedure.

Procedure
  1. In the orcharhino management UI, navigate to Infrastructure > HTTP Proxies.

  2. Click New HTTP Proxy.

  3. In the Name field, enter the name for the HTTP proxy.

  4. In the Url field, enter the URL of the HTTP proxy in the following format: https://proxy.example.com:8080.

  5. Optional: If authentication is required, in the Username field, enter the username to authenticate with.

  6. Optional: If authentication is required, in the Password field, enter the password to authenticate with.

  7. To test connection to the proxy, click Test Connection.

  8. Click Submit.

  9. In the orcharhino management UI, navigate to Administer > Settings, and click the Content tab.

  10. Set the Default HTTP Proxy setting to the created HTTP proxy.

CLI procedure
  1. Verify that the http_proxy, https_proxy, and no_proxy variables are not set.

    # unset http_proxy
    # unset https_proxy
    # unset no_proxy
  2. Add an HTTP proxy entry to orcharhino:

    # hammer http-proxy create --name=myproxy \
    --url http://myproxy.example.com:8080  \
    --username=proxy_username \
    --password=proxy_password
  3. Configure orcharhino to use this HTTP proxy by default:

    # hammer settings set --name=content_default_http_proxy --value=myproxy

4.3.2. Configuring SELinux to ensure access to orcharhino on custom ports

Procedure
  1. On orcharhino, to verify the ports that are permitted by SELinux for the HTTP cache, enter a command as follows:

    # semanage port -l | grep http_cache
    http_cache_port_t       tcp    8080, 8118, 8123, 10001-10010
    [output truncated]
  2. To configure SELinux to permit a port for the HTTP cache, for example 8088, enter a command as follows:

    # semanage port -a -t http_cache_port_t -p tcp 8088

4.3.3. Using an HTTP proxy for all orcharhino HTTP requests

If your orcharhino Server must remain behind a firewall that blocks HTTP and HTTPS, you can configure a proxy for communication with external systems, including compute resources.

Note that if you are using compute resources for provisioning, and you want to use a different HTTP proxy with the compute resources, the proxy that you set for all orcharhino communication takes precedence over the proxies that you set for compute resources.

Procedure
  1. In the orcharhino management UI, navigate to Administer > Settings.

  2. In the HTTP(S) proxy row, select the adjacent Value column and enter the proxy URL.

  3. Click the tick icon to save your changes.

CLI procedure
  • Enter the following command:

    # hammer settings set --name=http_proxy --value=Proxy_URL

4.3.4. Excluding hosts from receiving proxied requests

If you use an HTTP Proxy for all orcharhino HTTP or HTTPS requests, you can prevent certain hosts from communicating through the proxy.

Procedure
  1. In the orcharhino management UI, navigate to Administer > Settings.

  2. In the HTTP(S) proxy except hosts row, select the adjacent Value column and enter the names of one or more hosts that you want to exclude from proxy requests.

  3. Click the tick icon to save your changes.

CLI procedure
  • Enter the following command:

    # hammer settings set --name=http_proxy_except_list --value=[hostname1.hostname2...]

4.3.5. Configuring a proxy for PXE file downloads

For Red Hat content served through the Content Delivery Network, orcharhino Proxy downloads PXE files from synchronized repositories. However, when configuring and installing an operating system using Installation Media, orcharhino Proxy connects directly using the wget utility.

Procedure
  1. On orcharhino Proxy with the TFTP feature, to verify the ports that are permitted by SELinux for the HTTP cache, enter the following command:

    # systemctl edit foreman-proxy
  2. Insert the following test into the editor:

    [Service]
    Environment="http_proxy=http://proxy.example.com:8888"
    Environment="https_proxy=https://proxy.example.com:8888"
  3. Save the file. Verify that the file appears as /etc/systemd/system/foreman-proxy.service.d/overrides.conf.

  4. Restart the foreman-proxy service:

    # systemctl restart foreman-proxy
  5. Create a host or enter build mode for an existing host to re-download PXE files to the TFTP orcharhino Proxy.

4.3.6. Resetting the HTTP proxy

If you want to reset the current HTTP proxy setting, unset the Default HTTP Proxy setting.

Procedure
  1. In the orcharhino management UI, navigate to Administer > Settings, and click the Content tab.

  2. Set the Default HTTP Proxy setting to no global default.

CLI procedure
  • Set the content_default_http_proxy setting to an empty string:

    # hammer settings set --name=content_default_http_proxy --value=""

4.4. Enabling power management on hosts

To perform power management tasks on hosts using the intelligent platform management interface (IPMI) or a similar protocol, you must enable the baseboard management controller (BMC) module on orcharhino Server.

Prerequisites
Procedure
  • To enable BMC, enter the following command:

    # foreman-installer \
    --foreman-proxy-bmc "true" \
    --foreman-proxy-bmc-default-provider "freeipmi"

4.5. Configuring DNS, DHCP, and TFTP

You can manage DNS, DHCP, and TFTP centrally within the orcharhino environment, or you can manage them independently after disabling their maintenance on orcharhino.

4.5.1. Configuring DNS, DHCP, and TFTP on orcharhino Server

To configure the DNS, DHCP, and TFTP services on orcharhino Server, use the foreman-installer command with the options appropriate for your environment.

Any changes to the settings require entering the foreman-installer command again. You can enter the command multiple times and each time it updates all configuration files with the changed values.

Prerequisites
  • Ensure that the following information is available to you:

    • DHCP IP address ranges

    • DHCP gateway IP address

    • DHCP nameserver IP address

    • DNS information

    • TFTP server name

  • Use the FQDN instead of the IP address where possible in case of network changes.

  • Contact your network administrator to ensure that you have the correct settings.

Procedure
  • Enter the foreman-installer command with the options appropriate for your environment. The following example shows configuring full provisioning services:

    # foreman-installer \
    --foreman-proxy-dns true \
    --foreman-proxy-dns-managed true \
    --foreman-proxy-dns-zone example.com \
    --foreman-proxy-dns-reverse 2.0.192.in-addr.arpa \
    --foreman-proxy-dhcp true \
    --foreman-proxy-dhcp-managed true \
    --foreman-proxy-dhcp-range "192.0.2.100 192.0.2.150" \
    --foreman-proxy-dhcp-gateway 192.0.2.1 \
    --foreman-proxy-dhcp-nameservers 192.0.2.2 \
    --foreman-proxy-tftp true \
    --foreman-proxy-tftp-managed true \
    --foreman-proxy-tftp-servername 192.0.2.3

You can monitor the progress of the foreman-installer command displayed in your prompt. You can view the logs in /var/log/foreman-installer/katello.log.

Additional resources
  • For more information about the foreman-installer command, enter foreman-installer --help.

4.5.2. Disabling DNS, DHCP, and TFTP for unmanaged networks

If you want to manage TFTP, DHCP, and DNS services manually, you must prevent orcharhino from maintaining these services on the operating system and disable orchestration to avoid DHCP and DNS validation errors.

Important

Disabling these orcharhino Proxy features means orcharhino will no longer orchestrate DNS, DHCP, and TFTP, but it does not stop or remove the corresponding services.

Procedure
  1. Disable DHCP, DNS, and TFTP integration on your orcharhino Server:

    # foreman-installer --foreman-proxy-dhcp false \
    --foreman-proxy-dns false \
    --foreman-proxy-tftp false
  2. Disable the orcharhino Proxy integration for every subnet:

    1. In the orcharhino management UI, navigate to Infrastructure > Subnets.

    2. Select a subnet.

    3. On the orcharhino Proxies tab, clear the DHCP orcharhino Proxy, TFTP orcharhino Proxy, and Reverse DNS orcharhino Proxy fields.

  3. In the orcharhino management UI, navigate to Infrastructure > Domains and select a domain.

  4. Clear the DNS orcharhino Proxy field.

  5. Optional: If you use a DHCP service supplied by a third party, configure your DHCP server to pass the following options:

    Option 66: IP address of orcharhino or orcharhino Proxy
    Option 67: /pxelinux.0

    For more information about DHCP options, see RFC 2132.

Note
orcharhino does not perform orchestration when a orcharhino Proxy is not set for a given subnet and domain. When enabling or disabling orcharhino Proxy associations, orchestration commands for existing hosts can fail if the expected records and configuration files are not present. When associating a orcharhino Proxy to turn orchestration on, ensure the required DHCP and DNS records as well as the TFTP files are in place for the existing orcharhino hosts in order to prevent host deletion failures in the future.

4.5.3. Additional resources

4.6. Configuring orcharhino Server for outgoing emails

To send email messages from orcharhino Server, you can use either an SMTP server, or the sendmail command.

Prerequisites
  • Some SMTP servers with anti-spam protection or grey-listing features are known to cause problems. To setup outgoing email with such a service either install and configure a vanilla SMTP service on orcharhino Server for relay or use the sendmail command instead.

Procedure
  1. In the orcharhino management UI, navigate to Administer > Settings.

  2. Click the Email tab and set the configuration options to match your preferred delivery method. The changes have an immediate effect.

    1. The following example shows the configuration options for using an SMTP server:

      Table 5. Using an SMTP server as a delivery method
      Name Example value Additional information

      Delivery method

      SMTP

      SMTP address

      smtp.example.com

      SMTP authentication

      login

      SMTP HELO/EHLO domain

      example.com

      SMTP password

      password

      Use the login credentials for the SMTP server.

      SMTP port

      25

      SMTP username

      user@example.com

      Use the login credentials for the SMTP server.

    2. The following example uses gmail.com as an SMTP server:

      Table 6. Using gmail.com as an SMTP server
      Name Example value Additional information

      Delivery method

      SMTP

      SMTP address

      smtp.gmail.com

      SMTP authentication

      plain

      SMTP HELO/EHLO domain

      smtp.gmail.com

      SMTP enable StartTLS auto

      Yes

      SMTP password

      app password

      Use the Google app password. For more information, see Sign in with app passwords in Google Help Center.

      SMTP port

      587

      SMTP username

      user@gmail.com

      Use the Google account name.

    3. The following example uses the sendmail command as a delivery method:

      Table 7. Using sendmail as a delivery method
      Name Example value Additional information

      Delivery method

      Sendmail

      Sendmail location

      /usr/sbin/sendmail

      For security reasons, both Sendmail location and Sendmail argument settings are read-only and can be only set in /etc/foreman/settings.yaml. Both settings currently cannot be set via foreman-installer. For more information see the sendmail 1 man page.

      Sendmail arguments

      -i

  3. If you decide to send email using an SMTP server which uses TLS authentication, also perform one of the following steps:

    • Mark the CA certificate of the SMTP server as trusted. To do so, execute the following commands on orcharhino Server:

      # cp mailca.crt /etc/pki/ca-trust/source/anchors/
      # update-ca-trust enable
      # update-ca-trust

      Where mailca.crt is the CA certificate of the SMTP server.

    • Alternatively, in the orcharhino management UI, set the SMTP enable StartTLS auto option to No.

  4. Click Test email to send a test message to the user’s email address to confirm the configuration is working. If a message fails to send, the orcharhino management UI displays an error. See the log at /var/log/foreman/production.log for further details.

Additional resources

4.7. Configuring an alternate CNAME for orcharhino

You can configure an alternate CNAME for orcharhino. This might be useful if you want to deploy the orcharhino web interface on a different domain name than the one that is used by client systems to connect to orcharhino. You must plan the alternate CNAME configuration in advance prior to installing orcharhino Proxies and registering hosts to orcharhino to avoid redeploying new certificates to hosts.

4.7.1. Configuring orcharhino with an alternate CNAME

Use this procedure to configure orcharhino with an alternate CNAME. Note that the procedures for users of a default orcharhino certificate and custom certificate differ.

For default orcharhino certificate users
  • If you have installed orcharhino with a default orcharhino certificate and want to configure orcharhino with an alternate CNAME, enter the following command on orcharhino to generate a new default orcharhino SSL certificate with an additional CNAME.

    # foreman-installer --certs-cname alternate_fqdn --certs-update-server
  • If you have not installed orcharhino, you can add the --certs-cname alternate_fqdn option to the foreman-installer command to install orcharhino with an alternate CNAME.

For custom certificate users

If you use orcharhino with a custom certificate, when creating a custom certificate, include the alternate CNAME records to the custom certificate. For more information, see Creating a Custom SSL Certificate for orcharhino Server.

4.7.2. Configuring hosts to use an alternate orcharhino CNAME for content management

If orcharhino is configured with an alternate CNAME, you can configure hosts to use the alternate orcharhino CNAME for content management. To do this, you must point hosts to the alternate orcharhino CNAME prior to registering the hosts to orcharhino. You can do this using the bootstrap script or manually.

Configuring hosts with the bootstrap script

On the host, run the bootstrap script with the --server alternate_fqdn.example.com option to register the host to the alternate orcharhino CNAME:

# ./bootstrap.py --server alternate_fqdn.example.com
Configuring hosts manually

On the host, edit the /etc/rhsm/rhsm.conf file to update hostname and baseurl settings to point to the alternate host name, for example:

[server]
# Server hostname:
hostname = alternate_fqdn.example.com

content omitted

[rhsm]
# Content base URL:
baseurl=https://alternate_fqdn.example.com/pulp/content/

Now you can register the host with the subscription-manager.

4.8. Configuring orcharhino Server with a custom SSL certificate

By default, orcharhino uses a self-signed SSL certificate to enable encrypted communications between orcharhino Server, external orcharhino Proxies, and all hosts. If you cannot use a orcharhino self-signed certificate, you can configure orcharhino Server to use an SSL certificate signed by an external certificate authority (CA).

When you configure orcharhino with custom SSL certificates, you must fulfill the following requirements:

  • You must use the privacy-enhanced mail (PEM) encoding for the SSL certificates.

  • You must not use the same SSL certificate for both orcharhino Server and orcharhino Proxy.

  • The same CA must sign certificates for orcharhino Server and orcharhino Proxy.

  • An SSL certificate must not also be a CA certificate.

  • An SSL certificate must include a subject alt name (SAN) entry that matches the common name (CN).

  • An SSL certificate must be allowed for Key Encipherment using a Key Usage extension.

  • An SSL certificate must not have a shortname as the CN.

  • You must not set a passphrase for the private key.

To configure your orcharhino Server with a custom certificate, complete the following procedures:

  1. Creating a custom SSL certificate for orcharhino Server

  2. Deploying a custom SSL certificate to orcharhino Server

  3. Deploying a custom SSL certificate to hosts

  4. If you have external orcharhino Proxies registered to orcharhino Server, configure them with custom SSL certificates. For more information, see Configuring orcharhino Proxy with a Custom SSL Certificate in Installing orcharhino Proxy.

4.8.1. Creating a custom SSL certificate for orcharhino Server

Use this procedure to create a custom SSL certificate for orcharhino Server. If you already have a custom SSL certificate for orcharhino Server, skip this procedure.

Procedure
  1. To store all the source certificate files, create a directory that is accessible only to the root user:

    # mkdir /root/orcharhino_cert
  2. Create a private key with which to sign the certificate signing request (CSR).

    Note that the private key must be unencrypted. If you use a password-protected private key, remove the private key password.

    If you already have a private key for this orcharhino Server, skip this step.

    # openssl genrsa -out /root/orcharhino_cert/orcharhino_cert_key.pem 4096
  3. Create the /root/orcharhino_cert/openssl.cnf configuration file for the CSR and include the following content:

    [ req ]
    req_extensions = v3_req
    distinguished_name = req_distinguished_name
    prompt = no
    
    [ req_distinguished_name ]
    commonName = orcharhino.example.com
    
    [ v3_req ]
    basicConstraints = CA:FALSE
    keyUsage = digitalSignature, keyEncipherment
    extendedKeyUsage = serverAuth, clientAuth
    subjectAltName = @alt_names
    
    [ alt_names ]
    DNS.1 = orcharhino.example.com

    For more information about the [ v3_req ] parameters and their purpose, see RFC 5280: Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile.

  4. Optional: If you want to add Distinguished Name (DN) details to the CSR, add the following information to the [ req_distinguished_name ] section:

    [req_distinguished_name]
    CN = orcharhino.example.com
    countryName =My_Country_Name (1)
    stateOrProvinceName = My_State_Or_Province_Name (2)
    localityName = My_Locality_Name (3)
    organizationName = My_Organization_Or_Company_Name
    organizationalUnitName = My_Organizational_Unit_Name (4)
    1. Two letter code

    2. Full name

    3. Full name (example: New York)

    4. Division responsible for the certificate (example: IT department)

  5. Generate CSR:

    # openssl req -new \
    -key /root/orcharhino_cert/orcharhino_cert_key.pem \ (1)
    -config /root/orcharhino_cert/openssl.cnf \ (2)
    -out /root/orcharhino_cert/orcharhino_cert_csr.pem (3)
    1. Path to the private key

    2. Path to the configuration file

    3. Path to the CSR to generate

  6. Send the certificate signing request to the certificate authority (CA). The same CA must sign certificates for orcharhino Server and orcharhino Proxy.

    When you submit the request, specify the lifespan of the certificate. The method for sending the certificate request varies, so consult the CA for the preferred method. In response to the request, you can expect to receive a CA bundle and a signed certificate, in separate files.

4.8.2. Deploying a custom SSL certificate to orcharhino Server

Use this procedure to configure your orcharhino Server to use a custom SSL certificate signed by a Certificate Authority.

Important

Do not store the SSL certificates or .tar bundles in /tmp or /var/tmp directory. The operating system removes files from these directories periodically. As a result, foreman-installer fails to execute while enabling features or upgrading orcharhino Server.

Procedure
  • Update certificates on your orcharhino Server:

    # foreman-installer \
    --certs-server-cert "/root/orcharhino_cert/orcharhino_cert.pem" \ (1)
    --certs-server-key "/root/orcharhino_cert/orcharhino_cert_key.pem" \ (2)
    --certs-server-ca-cert "/root/orcharhino_cert/ca_cert_bundle.pem" \ (3)
    --certs-update-server --certs-update-server-ca
    1. Path to orcharhino Server certificate file that is signed by a Certificate Authority.

    2. Path to the private key that was used to sign orcharhino Server certificate.

    3. Path to the Certificate Authority bundle.

Verification
  1. On a computer with network access to orcharhino Server, navigate to the following URL: https://orcharhino.example.com.

  2. In your browser, view the certificate details to verify the deployed certificate.

4.8.3. Deploying a custom SSL certificate to hosts

After you configure orcharhino to use a custom SSL certificate, you must deploy the certificate to hosts registered to orcharhino.

Procedure
  • Update the SSL certificate on each host:

    # dnf install http://orcharhino.example.com/pub/katello-ca-consumer-latest.noarch.rpm

4.9. Resetting custom SSL certificate to default self-signed certificate on orcharhino Server

Procedure
  • Reset the custom SSL certificate to default self-signed certificate:

    # foreman-installer --certs-reset
Verification

Verify that the following parameters in /etc/foreman-installer/scenarios.d/katello-answers.yaml have no values:

  • server_cert:

  • server_key:

  • server_cert_req:

  • server_ca_cert:

4.10. Using external databases with orcharhino

As part of the installation process for orcharhino, the foreman-installer command installs PostgreSQL databases on the same server as orcharhino. In certain orcharhino deployments, using external databases instead of the default local databases can help with the server load.

To create and use external databases for orcharhino, you must complete the following procedures:

  1. Preparing a host for external databases. Prepare a host for the external databases.

  2. Installing PostgreSQL. Prepare PostgreSQL with databases for orcharhino, Candlepin and Pulp with dedicated users owning them.

  3. Configuring orcharhino Server to use external databases. Edit the parameters of foreman-installer to point to the new databases, and run foreman-installer.

4.10.1. PostgreSQL as an external database considerations

Foreman, Katello, and Candlepin use the PostgreSQL database. If you want to use PostgreSQL as an external database, the following information can help you decide if this option is right for your orcharhino configuration. orcharhino supports PostgreSQL version 12.

Advantages of external PostgreSQL
  • Increase in free memory and free CPU on orcharhino

  • Flexibility to set shared_buffers on the PostgreSQL database to a high number without the risk of interfering with other services on orcharhino

  • Flexibility to tune the PostgreSQL server’s system without adversely affecting orcharhino operations

Disadvantages of external PostgreSQL
  • Increase in deployment complexity that can make troubleshooting more difficult

  • The external PostgreSQL server is an additional system to patch and maintain

  • If either orcharhino or the PostgreSQL database server suffers a hardware or storage failure, orcharhino is not operational

  • If there is latency between the orcharhino server and database server, performance can suffer

4.10.2. Preparing a host for external databases

Install a freshly provisioned system with the latest Enterprise Linux 9 or Enterprise Linux 8 to host the external databases.

Prerequisites
Procedure

Ensure the prepared host has the same content available as your orcharhino Server.

4.10.3. Installing PostgreSQL

You can install only the same version of PostgreSQL that is installed with the foreman-installer tool during an internal database installation. orcharhino supports PostgreSQL version 12.

Procedure
  1. To install PostgreSQL, enter the following command:

    # dnf install postgresql-server postgresql-evr postgresql-contrib
  2. To initialize PostgreSQL, enter the following command:

    # postgresql-setup initdb
  3. Edit the /var/lib/pgsql/data/postgresql.conf file:

    # vi /var/lib/pgsql/data/postgresql.conf

    Note that the default configuration of external PostgreSQL needs to be adjusted to work with orcharhino. The base recommended external database configuration adjustments are as follows:

    • checkpoint_completion_target: 0.9

    • max_connections: 500

    • shared_buffers: 512MB

    • work_mem: 4MB

  4. Remove the # and edit to listen to inbound connections:

    listen_addresses = '*'
  5. Edit the /var/lib/pgsql/data/pg_hba.conf file:

    # vi /var/lib/pgsql/data/pg_hba.conf
  6. Add the following line to the file:

      host  all   all   orcharhino_ip/32   md5
  7. To start, and enable PostgreSQL service, enter the following commands:

    # systemctl enable --now postgresql
  8. Open the postgresql port on the external PostgreSQL server:

    # firewall-cmd --add-service=postgresql
  9. Make the changes persistent:

    # firewall-cmd --runtime-to-permanent
  10. Switch to the postgres user and start the PostgreSQL client:

    $ su - postgres -c psql
  11. Create three databases and dedicated roles: one for orcharhino, one for Candlepin, and one for Pulp:

    CREATE USER "foreman" WITH PASSWORD 'Foreman_Password';
    CREATE USER "candlepin" WITH PASSWORD 'Candlepin_Password';
    CREATE USER "pulp" WITH PASSWORD 'Pulpcore_Password';
    CREATE DATABASE foreman OWNER foreman;
    CREATE DATABASE candlepin OWNER candlepin;
    CREATE DATABASE pulpcore OWNER pulp;
  12. Connect to the Pulp database:

    postgres=# \c pulpcore
    You are now connected to database "pulpcore" as user "postgres".
  13. Create the hstore extension:

    pulpcore=# CREATE EXTENSION IF NOT EXISTS "hstore";
    CREATE EXTENSION
  14. Exit the postgres user:

    # \q
  15. From orcharhino Server, test that you can access the database. If the connection succeeds, the commands return 1.

    # PGPASSWORD='Foreman_Password' psql -h postgres.example.com  -p 5432 -U foreman -d foreman -c "SELECT 1 as ping"
    # PGPASSWORD='Candlepin_Password' psql -h postgres.example.com -p 5432 -U candlepin -d candlepin -c "SELECT 1 as ping"
    # PGPASSWORD='Pulpcore_Password' psql -h postgres.example.com -p 5432 -U pulp -d pulpcore -c "SELECT 1 as ping"

4.10.4. Configuring orcharhino Server to use external databases

Use the foreman-installer command to configure orcharhino to connect to an external PostgreSQL database.

Prerequisites
  • You have installed and configured a PostgreSQL database on a Enterprise Linux server.

Procedure
  1. To configure the external databases for orcharhino, enter the following command:

    # foreman-installer \
    --katello-candlepin-manage-db false \
    --katello-candlepin-db-host postgres.example.com \
    --katello-candlepin-db-name candlepin \
    --katello-candlepin-db-user candlepin \
    --katello-candlepin-db-password Candlepin_Password \
    --foreman-proxy-content-pulpcore-manage-postgresql false \
    --foreman-proxy-content-pulpcore-postgresql-host postgres.example.com \
    --foreman-proxy-content-pulpcore-postgresql-db-name pulpcore \
    --foreman-proxy-content-pulpcore-postgresql-user pulp \
    --foreman-proxy-content-pulpcore-postgresql-password Pulpcore_Password \
    --foreman-db-manage false \
    --foreman-db-host postgres.example.com \
    --foreman-db-database foreman \
    --foreman-db-username foreman \
    --foreman-db-password Foreman_Password

    To enable the Secure Sockets Layer (SSL) protocol for these external databases, add the following options:

    --foreman-db-root-cert <path_to_CA>
    --foreman-db-sslmode verify-full
    --foreman-proxy-content-pulpcore-postgresql-ssl true
    --foreman-proxy-content-pulpcore-postgresql-ssl-root-ca <path_to_CA>
    --katello-candlepin-db-ssl true
    --katello-candlepin-db-ssl-ca <path_to_CA>
    --katello-candlepin-db-ssl-verify true

5. Configuring external authentication

By using external authentication you can derive user and user group permissions from user group membership in an external identity provider. When you use external authentication, you do not have to create these users and maintain their group membership manually on orcharhino Server. In case the external source does not provide email, it will be requested during the first login through orcharhino management UI.

Important user and group account information

All user and group accounts must be local accounts. This is to ensure that there are no authentication conflicts between local accounts on your orcharhino Server and accounts in your Active Directory domain.

Your system is not affected by this conflict if your user and group accounts exist in both /etc/passwd and /etc/group files. For example, to check if entries for puppet, apache, foreman and foreman-proxy groups exist in both /etc/passwd and /etc/group files, enter the following commands:

# cat /etc/passwd | grep 'puppet\|apache\|foreman\|foreman-proxy'
# cat /etc/group | grep 'puppet\|apache\|foreman\|foreman-proxy'
Scenarios for configuring external authentication

orcharhino supports the following general scenarios for configuring external authentication:

  • Using Lightweight Directory Access Protocol (LDAP) server as an external identity provider. LDAP is a set of open protocols used to access centrally stored information over a network. With orcharhino, you can manage LDAP entirely through the orcharhino management UI. For more information, see Using LDAP. Though you can use LDAP to connect to a FreeIPA or AD server, the setup does not support server discovery, cross-forest trusts, or single sign-on with Kerberos in orcharhino’s web UI.

  • Using a FreeIPA server as an external identity provider. FreeIPA deals with the management of individual identities, their credentials and privileges used in a networking environment. Configuration using FreeIPA cannot be completed using only the orcharhino management UI and requires some interaction with the CLI. For more information see Using FreeIPA.

  • Using Active Directory (AD) integrated with FreeIPA through cross-forest Kerberos trust as an external identity provider. For more information see Active Directory with cross-forest trust.

  • Using Keycloak as an OpenID provider for external authentication to orcharhino. For more information, see Configuring orcharhino with Keycloak authentication.

  • Using Keycloak as an OpenID provider for external authentication to orcharhino with TOTP. For more information, see Configuring Keycloak authentication with TOTP.

As well as providing access to orcharhino Server, hosts provisioned with orcharhino can also be integrated with FreeIPA realms. orcharhino has a realm feature that automatically manages the lifecycle of any system registered to a realm or domain provider. For more information, see External authentication for provisioned hosts.

Table 8. Authentication overview
Type Authentication User Groups

FreeIPA

Kerberos or LDAP

Yes

Active Directory

Kerberos or LDAP

Yes

POSIX

LDAP

Yes

5.1. Using LDAP

orcharhino supports LDAP authentication using one or multiple LDAP directories. Your LDAP server must comply with the RFC 2307 schema.

If you do not require secure LDAP at this time, proceed to Configuring orcharhino to use LDAP.

Important

Users cannot use both FreeIPA and LDAP as an authentication method. Once a user authenticates using one method, they cannot use the other method.

To change the authentication method for a user, you have to remove the automatically created user from orcharhino.

For more information on using FreeIPA as an authentication method, see Using FreeIPA.

5.1.1. Configuring TLS for secure LDAP

If orcharhino uses TLS to establish a secure LDAP connection (LDAPS), you must obtain the CA certificates of your LDAP server and add them to the trusted CA list on the base operating system of your orcharhino Server.

If your LDAP server uses a certificate chain with intermediate certificate authorities, you must obtain all root and intermediate certificates and add them to the trusted CA list.

Procedure
  1. Obtain the CA certificate from the LDAP Server:

    1. If you use Active Directory Certificate Services, export the Enterprise PKI CA Certificate using the Base64 encoded X.509 format.

    2. Download the LDAP server certificate to a temporary location on the orcharhino Server, such as /tmp/example.crt. You will remove the certificate when finished.

      The filename extensions .cer and .crt are only conventions and can refer to DER binary or PEM ASCII format certificates.

  2. Add the LDAP server certificate to the system truststore:

    1. Import the certificate:

      # cp /tmp/example.crt /etc/pki/tls/source/anchors
    2. Update the certificate authority truststore:

      # update-ca-trust extract
  3. Delete the downloaded LDAP certificate from the temporary location on your orcharhino Server.

5.1.2. Configuring orcharhino to use LDAP

In the orcharhino management UI, configure orcharhino to use LDAP.

Note that if you need single sign-on functionality with Kerberos on orcharhino management UI, you should use FreeIPA and AD external authentication instead. For more information, see:

Procedure
  1. Set the Network Information System (NIS) service boolean to true to prevent SELinux from stopping outgoing LDAP connections:

    # setsebool -P nis_enabled on
  2. In the orcharhino management UI, navigate to Administer > Authentication Sources.

  3. Click Create LDAP Authentication Source.

  4. On the LDAP server tab, enter the LDAP server’s name, host name, port, and server type. The default port is 389, the default server type is POSIX (alternatively you can select FreeIPA or Active Directory depending on the type of authentication server). For TLS encrypted connections, select the LDAPS checkbox to enable encryption. The port should change to 636, which is the default for LDAPS.

  5. On the Account tab, enter the account information and domain name details. See Description of LDAP settings for descriptions and examples.

  6. On the Attribute mappings tab, map LDAP attributes to orcharhino attributes. You can map login name, first name, last name, email address, and photo attributes. See Example settings for LDAP connections for examples.

  7. On the Locations tab, select locations from the left table. Selected locations are assigned to users created from the LDAP authentication source, and available after their first login.

  8. On the Organizations tab, select organizations from the left table. Selected organizations are assigned to users created from the LDAP authentication source, and available after their first login.

  9. Click Submit.

  10. Configure new accounts for LDAP users:

    • If you did not select Automatically Create Accounts In orcharhino checkbox, see Creating a User in Administering orcharhino to create user accounts manually.

    • If you selected the Automatically Create Accounts In orcharhino checkbox, LDAP users can now log in to orcharhino using their LDAP accounts and passwords. After they log in for the first time, the orcharhino administrator has to assign roles to them manually. For more information on assigning user accounts appropriate roles in orcharhino, see Assigning Roles to a User in Administering orcharhino.

5.1.3. Description of LDAP settings

The following table provides a description for each setting in the Account tab.

Table 9. Account tab settings
Setting Description

Account

The user name of the LDAP account that has read access to the LDAP server. User name is not required if the server allows anonymous reading, otherwise use the full path to the user’s object. For example:

uid=$login,cn=users,cn=accounts,dc=example,dc=com

The $login variable stores the username entered on the login page as a literal string. The value is accessed when the variable is expanded.

The variable cannot be used with external user groups from an LDAP source because orcharhino needs to retrieve the group list without the user logging in. Use either an anonymous, or dedicated service user.

Account password

The LDAP password for the user defined in the Account username field. This field can remain blank if the Account username is using the $login variable.

Base DN

The top level domain name of the LDAP directory.

Groups base DN

The top level domain name of the LDAP directory tree that contains groups.

LDAP filter

A filter to restrict LDAP queries.

Automatically Create Accounts In orcharhino

If this checkbox is selected, orcharhino creates user accounts for LDAP users when they log in to orcharhino for the first time. After they log in for the first time, the orcharhino administrator has to assign roles to them manually. See Assigning Roles to a User in Administering orcharhino to assign user accounts appropriate roles in orcharhino.

Usergroup Sync

If this option is selected, the user group membership of a user is automatically synchronized when the user logs in, which ensures the membership is always up to date. If this option is cleared, orcharhino relies on a cron job to regularly synchronize group membership (every 30 minutes by default). For more information, see Configuring external user groups.

5.1.4. Example settings for LDAP connections

The following table shows example settings for different types of LDAP connections. The example below uses a dedicated service account called redhat that has bind, read, and search permissions on the user and group entries. Note that LDAP attribute names are case sensitive.

Table 10. Example settings for Active Directory, Free IPA or Red Hat Identity Management and POSIX LDAP connections
Setting Active Directory FreeIPA or Red Hat Identity Management POSIX (OpenLDAP)

Account

DOMAIN\redhat

uid=redhat,cn=users, cn=accounts,dc=example, dc=com

uid=redhat,ou=users, dc=example,dc=com

Account password

P@ssword

-

-

Base DN

DC=example,DC=COM

dc=example,dc=com

dc=example,dc=com

Groups Base DN

CN=Users,DC=example,DC=com

cn=groups,cn=accounts, dc=example,dc=com

cn=employee,ou=userclass, dc=example,dc=com

Login name attribute

userPrincipalName

uid

uid

First name attribute

givenName

givenName

givenName

Last name attribute

sn

sn

sn

Email address attribute

mail

mail

mail

Photo attribute

thumbnailPhoto

-

-

Note

userPrincipalName allows the use of whitespace in usernames. The login name attribute sAMAccountName (which is not listed in the table above) provides backwards compatibility with legacy Microsoft systems. sAMAccountName does not allow the use of whitespace in usernames.

5.1.5. Example LDAP filters

As an administrator, you can create LDAP filters to restrict the access of specific users to orcharhino.

Table 11. Example filters for allowing specific users to login
User Filter

User1

(distinguishedName=cn=User1,cn=Users,dc=domain,dc=example)

User1, User3

(memberOf=cn=Group1,cn=Users,dc=domain,dc=example)

User2, User3

(memberOf=cn=Group2,cn=Users,dc=domain,dc=example)

User1, User2, User3

(|(memberOf=cn=Group1,cn=Users,dc=domain,dc=example)(memberOf=cn=Group2,cn=Users,dc=domain,dc=example))

User1, User2, User3

(memberOf:1.2.840.113556.1.4.1941:=cn=Users,dc=domain,dc=example)

Note

Group Users is a nested group that contains groups Group1 and Group2. If you want to filter all users from a nested group, you must add memberOf:1.2.840.113556.1.4.1941:= before the nested group name. See the last example in the table above.

LDAP directory structure

The LDAP directory structure that the filters in the example use:

DC=Domain,DC=Example
   |
   |----- CN=Users
         |
         |----- CN=Group1
         |----- CN=Group2
         |----- CN=User1
         |----- CN=User2
         |----- CN=User3
LDAP group membership

The group membership that the filters in the example use:

Group Members

Group1

User1, User3

Group2

User2, User3

5.2. Using FreeIPA

This section shows how to integrate orcharhino Server with a FreeIPA server and how to enable host-based access control.

Note

You can attach FreeIPA as an external authentication source with no single sign-on support. For more information, see Using LDAP.

Important

Users cannot use both FreeIPA and LDAP as an authentication method. Once a user authenticates using one method, they cannot use the other method.

To change the authentication method for a user, you have to remove the automatically created user from orcharhino.

Prerequisites
  • The base operating system of orcharhino Server must be enrolled in the FreeIPA domain by the FreeIPA administrator of your organization.

The examples in this chapter assume separation between FreeIPA and orcharhino configuration.

5.2.1. Configuring FreeIPA authentication on orcharhino Server

In the orcharhino CLI, configure FreeIPA authentication by first creating a host entry on the FreeIPA server.

Procedure
  1. On the FreeIPA server, to authenticate, enter the following command and enter your password when prompted:

    # kinit admin
  2. To verify that you have authenticated, enter the following command:

    # klist
  3. On the FreeIPA server, create a host entry for orcharhino Server and generate a one-time password, for example:

    # ipa host-add --random hostname
    Note

    The generated one-time password must be used on the client to complete FreeIPA-enrollment.

  4. Create an HTTP service for orcharhino Server, for example:

    # ipa service-add HTTP/hostname
  5. On orcharhino Server, install the IPA client:

    # dnf install ipa-client
  6. On orcharhino Server, enter the following command as root to configure FreeIPA-enrollment:

    # ipa-client-install --password OTP

    Replace OTP with the one-time password provided by the FreeIPA administrator.

  7. Set FreeIPA as the authentication provider, using one of the following commands:

    • If you only want to enable access to the orcharhino management UI but not the orcharhino API, enter:

      # foreman-installer \
      --foreman-ipa-authentication=true
    • If you want to enable access both to the orcharhino management UI and the orcharhino API, enter:

      # foreman-installer \
      --foreman-ipa-authentication-api=true \
      --foreman-ipa-authentication=true
      Warning

      Enabling access to both the orcharhino API and the orcharhino management UI can lead to security problems. After an IdM user receives a Kerberos ticket-granting ticket (TGT) by entering kinit user_name, an attacker can obtain an API session. The attack is possible even if the user did not previously enter the orcharhino login credentials anywhere, for example in the browser.

  8. Restart orcharhino services:

    # foreman-maintain service restart

External users can now log in to orcharhino using their FreeIPA credentials. They can now choose to either log in to orcharhino Server directly using their username and password or take advantage of the configured Kerberos single sign-on and obtain a ticket on their client machine and be logged in automatically. The two-factor authentication with one-time password (2FA OTP) is also supported.

5.2.2. Configuring host-based authentication control

HBAC rules define which machine within the domain a FreeIPA user is allowed to access. You can configure HBAC on the FreeIPA server to prevent selected users from accessing orcharhino Server. With this approach, you can prevent orcharhino from creating database entries for users that are not allowed to log in.

On the FreeIPA server, configure Host-Based Authentication Control (HBAC).

Procedure
  1. On the FreeIPA server, to authenticate, enter the following command and enter your password when prompted:

    # kinit admin
  2. To verify that you have authenticated, enter the following command:

    # klist
  3. Create HBAC service and rule on the FreeIPA server and link them together. The following examples use the PAM service name orcharhino-prod. Execute the following commands on the FreeIPA server:

    # ipa hbacsvc-add orcharhino-prod
    # ipa hbacrule-add allow_orcharhino_prod
    # ipa hbacrule-add-service allow_orcharhino_prod --hbacsvcs=orcharhino-prod
  4. Add the user who is to have access to the service orcharhino-prod, and the hostname of orcharhino Server:

    # ipa hbacrule-add-user allow_orcharhino_prod --user=username
    # ipa hbacrule-add-host allow_orcharhino_prod --hosts=orcharhino.example.com

    Alternatively, host groups and user groups can be added to the alloworcharhino_prod_ rule.

  5. To check the status of the rule, execute:

    # ipa hbacrule-find orcharhino-prod
    # ipa hbactest --user=username --host=orcharhino.example.com --service=orcharhino-prod
  6. Ensure the allow_all rule is disabled on the FreeIPA server.

  7. Configure the FreeIPA integration with orcharhino Server as described in Configuring FreeIPA authentication on orcharhino Server. On orcharhino Server, define the PAM service as root:

    # foreman-installer --foreman-pam-service=orcharhino-prod

5.3. Using Active Directory

This section shows how to use direct Active Directory (AD) as an external authentication source for orcharhino Server.

Note

You can attach Active Directory as an external authentication source with no single sign-on support. For more information, see Using LDAP.

Direct AD integration means that orcharhino Server is joined directly to the AD domain where the identity is stored.

5.3.1. Configuring the Active Directory authentication source on orcharhino Server

Enable Active Directory (AD) users to access orcharhino by configuring the corresponding authentication provider on your orcharhino Server.

Prerequisites
  • The base system of your orcharhino Server must be joined to an Active Directory (AD) domain. To enable AD users to sign in with Kerberos single sign-on, use the System Security Services Daemon (SSSD) and Samba services to join the base system to the AD domain:

    Install the following packages on orcharhino Server:

    # dnf install adcli krb5-workstation oddjob-mkhomedir oddjob realmd samba-winbind-clients samba-winbind samba-common-tools samba-winbind-krb5-locator sssd

    Specify the required software when joining the AD domain:

    # realm join AD.EXAMPLE.COM --membership-software=samba --client-software=sssd

    For more information on direct AD integration, see Connecting RHEL systems directly to AD using Samba Winbind.

Procedure
  1. Define AD realm configuration in a location where foreman-installer expects it:

    1. Create a directory named /etc/ipa/:

      # mkdir /etc/ipa/
    2. Create the /etc/ipa/default.conf file with the following contents to configure the Kerberos realm for the AD domain:

      [global]
      realm = AD.EXAMPLE.COM
  2. Configure the Apache keytab for Kerberos connections:

    1. Update the /etc/samba/smb.conf file with the following settings to configure how Samba interacts with AD:

      [global]
      workgroup = AD.EXAMPLE
      realm = AD.EXAMPLE.COM
      kerberos method = system keytab
      security = ads
    2. Add the Kerberos service principal to the keytab file at /etc/httpd/conf/http.keytab:

      # KRB5_KTNAME=FILE:/etc/httpd/conf/http.keytab net ads keytab add HTTP -U Administrator -s /etc/samba/smb.conf
  3. Configure the System Security Services Daemon (SSSD) to use the AD access control provider to evaluate and enforce Group Policy Object (GPO) access control rules for the foreman PAM service:

    1. In the [domain/ad.example.com] section of your /etc/sssd/sssd.conf file, configure the ad_gpo_access_control and ad_gpo_map_service options as follows:

      [domain/ad.example.com]
      ad_gpo_access_control = enforcing
      ad_gpo_map_service = +foreman
    2. Restart SSSD:

      # systemctl restart sssd
  4. Enable the authentication source:

    # foreman-installer --foreman-ipa-authentication=true
Verification
  • To verify that AD users can log in to orcharhino by entering their credentials, log in to orcharhino management UI at https://orcharhino.example.com. Enter the user name in the user principal name (UPN) format, for example: ad_user@AD.EXAMPLE.COM.

  • To verify that AD users can authenticate by using Kerberos single sign-on:

    • Obtain a Kerberos ticket-granting ticket (TGT) on behalf of an AD user:

      $ kinit ad_user@AD.EXAMPLE.COM
    • Verify user authentication by using your TGT:

      $ curl -k -u : --negotiate https://orcharhino.example.com/users/extlogin
      
      <html><body>You are being <a href="orcharhino.example.com/hosts">redirected</a>.</body></html>
Troubleshooting
  • Connecting to the AD LDAP can sometimes fail with an error such as the following appearing in the logs:

    Authentication failed with status code: {
      "error": { "message": "ERF77-7629 [Foreman::LdapException]: Error while connecting to 'server.com' LDAP server at 'ldap.example.com' during authentication ([Net::LDAP::Error]: Connection reset by peer - SSL_connect)" } }

    If you see this error, verify which cipher is used for the connection:

    # openssl s_client -connect ldap.example.com:636

    If the TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 cipher is used, disable it on either the orcharhino Server side or on the AD side. The TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 cipher is known to cause incompatibilities.

  • sssd-ad(5) man page on your system

5.3.2. Kerberos configuration in web browsers

If you use the Internet Explorer browser, add orcharhino Server to the list of Local Intranet or Trusted sites, and turn on the Enable Integrated Windows Authentication setting. See the Internet Explorer documentation for details.

5.3.3. Active Directory with cross-forest trust

Kerberos can create cross-forest trust that defines a relationship between two otherwise separate domain forests. A domain forest is a hierarchical structure of domains; both AD and FreeIPA constitute a forest. With a trust relationship enabled between AD and FreeIPA, users of AD can access Linux hosts and services using a single set of credentials.

From the orcharhino point of view, the configuration process is the same as integration with FreeIPA server without cross-forest trust configured. orcharhino Server has to be enrolled in the IdM domain and integrated as described in Using FreeIPA.

5.3.4. Configuring the FreeIPA server to use cross-forest trust

On the FreeIPA server, configure the server to use cross-forest trust.

Procedure
  1. Enable HBAC:

    1. Create an external group and add the AD group to it.

    2. Add the new external group to a POSIX group.

    3. Use the POSIX group in a HBAC rule.

  2. Configure sssd to transfer additional attributes of AD users.

    • Add the AD user attributes to the nss and domain sections in /etc/sssd/sssd.conf. For example:

      [nss]
      user_attributes=+mail, +sn, +givenname
      [domain/EXAMPLE.com]
      ...
      krb5_store_password_if_offline = True
      ldap_user_extra_attrs=email:mail, lastname:sn, firstname:givenname
      
      [ifp]
      allowed_uids = ipaapi, root
      user_attributes=+email, +firstname, +lastname
    • Verify the AD attributes value.

      # dbus-send --print-reply --system --dest=org.freedesktop.sssd.infopipe /org/freedesktop/sssd/infopipe org.freedesktop.sssd.infopipe.GetUserAttr string:ad-user@ad-domain array:string:email,firstname,lastname

5.4. Configuring external user groups

orcharhino does not associate external users with their user group automatically. You must create a user group with the same name as in the external source on orcharhino. Members of the external user group then automatically become members of the orcharhino user group and receive the associated permissions.

The configuration of external user groups depends on the type of external authentication.

To assign additional permissions to an external user, add this user to an internal user group that has no external mapping specified. Then assign the required roles to this group.

Prerequisites
  • If you use an LDAP server, configure orcharhino to use LDAP authentication. For more information see Using LDAP.

    When using external user groups from an LDAP source, you cannot use the $login variable as a substitute for the account user name. You must use either an anonymous or dedicated service user.

  • If you use a FreeIPA or AD server, configure orcharhino to use FreeIPA or AD authentication. For more information, see Configuring External Authentication in Installing orcharhino Server.

  • Ensure that at least one external user authenticates for the first time.

  • Retain a copy of the external group names you want to use. To find the group membership of external users, enter the following command:

    # id username
Procedure
  1. In the orcharhino management UI, navigate to Administer > User Groups, and click Create User Group.

  2. Specify the name of the new user group. Do not select any users to avoid adding users automatically when you refresh the external user group.

  3. Click the Roles tab and select the roles you want to assign to the user group. Alternatively, select the Administrator checkbox to assign all available permissions.

  4. Click the External groups tab, then click Add external user group, and select an authentication source from the Auth source drop-down menu.

    Specify the exact name of the external group in the Name field.

  5. Click Submit.

5.5. Refreshing external user groups for LDAP

To set the LDAP source to synchronize user group membership automatically on user login, in the Auth Source page, select the Usergroup Sync option. If this option is not selected, LDAP user groups are refreshed automatically through a scheduled cron job synchronizing the LDAP Authentication source every 30 minutes by default.

If the user groups in the LDAP Authentication source change in the lapse of time between scheduled tasks, the user can be assigned to incorrect external user groups. This is corrected automatically when the scheduled task runs.

Use this procedure to refresh the LDAP source manually.

Procedure
  1. In the orcharhino management UI, navigate to Administer > Usergroups and select a user group.

  2. On the External Groups tab, click Refresh to the right of the required user group.

CLI procedure
  • Enter the following command:

    # foreman-rake ldap:refresh_usergroups

5.6. Refreshing external user groups for FreeIPA or AD

External user groups based on FreeIPA or AD are refreshed only when a group member logs in to orcharhino. It is not possible to alter user membership of external user groups in the orcharhino management UI, such changes are overwritten on the next group refresh.

5.7. Configuring the Hammer CLI to use FreeIPA user authentication

This section describes how to configure the orcharhino Hammer command-line interface (CLI) tool to use FreeIPA (IdM) to authenticate users.

Prerequisites
  • You are logged in to the host from which you want to access orcharhino by using Hammer.

Procedure
  1. Enable sessions in the ~/.hammer/cli.modules.d/foreman.yml Hammer configuration file by adding the :use_sessions: true line to the foreman parameters:

    :foreman:
      :use_sessions: true

    Adding the line enforces session usage in Hammer. This means that Hammer performs the authentication request only once instead of with each hammer command.

  2. Optional: Enable negotiate authentication in the ~/.hammer/cli.modules.d/foreman.yml Hammer configuration file by adding the :default_auth_type: 'Negotiate_Auth' line to the foreman parameters:

    :foreman:
      :default_auth_type: 'Negotiate_Auth'
      :use_sessions: true

    Adding this line means that your authentication is negotiated when you enter the first hammer command. If this entry is present, Hammer tries to communicate with orcharhino Server using the negotiation protocol.

5.8. External authentication for provisioned hosts

Use this section to configure orcharhino Server or orcharhino Proxy for FreeIPA realm support, then add hosts to the FreeIPA realm group.

Prerequisites
  • orcharhino Server that is registered to the Content Delivery Network or an external orcharhino Proxy that is registered to orcharhino Server.

  • A deployed realm or domain provider such as FreeIPA.

To install and configure FreeIPA packages on orcharhino Server or orcharhino Proxy:

To use FreeIPA for provisioned hosts, complete the following steps to install and configure FreeIPA packages on orcharhino Server or orcharhino Proxy:

  1. Install the ipa-client package on orcharhino Server or orcharhino Proxy:

    # dnf install ipa-client
  2. Configure the server as a FreeIPA client:

    # ipa-client-install
  3. Create a realm proxy user, realm-orcharhino-proxy, and the relevant roles in FreeIPA:

    # foreman-prepare-realm admin realm-orcharhino-proxy

    Note the principal name that returns and your FreeIPA server configuration details because you require them for the following procedure.

To configure orcharhino Server or orcharhino Proxy for FreeIPA realm support:

Complete the following procedure on orcharhino and every orcharhino Proxy that you want to use:

  1. Copy the /root/freeipa.keytab file to any orcharhino Proxy that you want to include in the same principal and realm:

    # scp /root/freeipa.keytab root@orcharhino-proxy.example.com:/etc/foreman-proxy/freeipa.keytab
  2. On your orcharhino Server, move the /root/freeipa.keytab file to the /etc/foreman-proxy directory:

    # mv /root/freeipa.keytab /etc/foreman-proxy
  3. On your orcharhino Server and orcharhino Proxys, set ownership to the foreman-proxy user and group:

    # chown foreman-proxy:foreman-proxy /etc/foreman-proxy/freeipa.keytab
  4. Enter the following command on all orcharhino Proxies that you want to include in the realm. If you use the integrated orcharhino Proxy on orcharhino, enter this command on orcharhino Server:

    # foreman-installer --foreman-proxy-realm true \
    --foreman-proxy-realm-keytab /etc/foreman-proxy/freeipa.keytab \
    --foreman-proxy-realm-principal realm-orcharhino-proxy@EXAMPLE.COM \
    --foreman-proxy-realm-provider freeipa

    You can also use these options when you first configure the orcharhino Server.

  5. Ensure that the most updated versions of the ca-certificates package is installed and trust the FreeIPA Certificate Authority:

    # cp /etc/ipa/ca.crt /etc/pki/ca-trust/source/anchors/ipa.crt
    # update-ca-trust enable
    # update-ca-trust
  6. Optional: If you configure FreeIPA on an existing orcharhino Server or orcharhino Proxy, complete the following steps to ensure that the configuration changes take effect:

    1. Restart the foreman-proxy service:

      # systemctl restart foreman-proxy
    2. In the orcharhino management UI, navigate to Infrastructure > orcharhino Proxies.

    3. Locate the orcharhino Proxy you have configured for FreeIPA and from the list in the Actions column, select Refresh.

To create a realm for the FreeIPA-enabled orcharhino Proxy

After you configure your integrated or external orcharhino Proxy with FreeIPA, you must create a realm and add the FreeIPA-configured orcharhino Proxy to the realm.

Procedure
  1. In the orcharhino management UI, navigate to Infrastructure > Realms and click Create Realm.

  2. In the Name field, enter a name for the realm.

  3. From the Realm Type list, select the type of realm.

  4. From the Realm orcharhino Proxy list, select orcharhino Proxy where you have configured FreeIPA.

  5. Click the Locations tab and from the Locations list, select the location where you want to add the new realm.

  6. Click the Organizations tab and from the Organizations list, select the organization where you want to add the new realm.

  7. Click Submit.

Updating host groups with realm information

You must update any host groups that you want to use with the new realm information.

  1. In the orcharhino management UI, navigate to Configure > Host Groups, select the host group that you want to update, and click the Network tab.

  2. From the Realm list, select the realm you create as part of this procedure, and then click Submit.

Adding hosts to a FreeIPA host group

FreeIPA supports the ability to set up automatic membership rules based on a system’s attributes. orcharhino’s realm feature provides administrators with the ability to map the orcharhino host groups to the FreeIPA parameter userclass which allow administrators to configure automembership.

When nested host groups are used, they are sent to the FreeIPA server as they are displayed in the orcharhino User Interface. For example, "Parent/Child/Child".

orcharhino Server or orcharhino Proxy sends updates to the FreeIPA server, however automembership rules are only applied at initial registration.

To add hosts to a FreeIPA host group:
  1. On the FreeIPA server, create a host group:

    # ipa hostgroup-add hostgroup_name --desc=hostgroup_description
  2. Create an automembership rule:

    # ipa automember-add --type=hostgroup hostgroup_name automember_rule

    Where you can use the following options:

    • automember-add flags the group as an automember group.

    • --type=hostgroup identifies that the target group is a host group, not a user group.

    • automember_rule adds the name you want to identify the automember rule by.

  3. Define an automembership condition based on the userclass attribute:

    # ipa automember-add-condition --key=userclass --type=hostgroup --inclusive-regex=^webserver hostgroup_name
    ----------------------------------
    Added condition(s) to "hostgroup_name"
    ----------------------------------
    Automember Rule: automember_rule
    Inclusive Regex: userclass=^webserver
    ----------------------------
    Number of conditions added 1
    ----------------------------

    Where you can use the following options:

    • automember-add-condition adds regular expression conditions to identify group members.

    • --key=userclass specifies the key attribute as userclass.

    • --type=hostgroup identifies that the target group is a host group, not a user group.

    • --inclusive-regex= ^webserver identifies matching values with a regular expression pattern.

    • hostgroup_name – identifies the target host group’s name.

When a system is added to orcharhino Server’s hostgroup_name host group, it is added automatically to the FreeIPA server’s "hostgroup_name" host group. FreeIPA host groups allow for Host-Based Access Controls (HBAC), sudo policies and other FreeIPA functions.

5.9. Configuring orcharhino with Keycloak authentication

Use this section to configure orcharhino to use Keycloak as an OpenID provider for external authentication.

5.9.1. Prerequisites for configuring orcharhino with Keycloak authentication

Before configuring orcharhino with Keycloak external authentication, ensure that you meet the following requirements:

  • A working installation of Keycloak server that uses HTTPS instead of HTTP.

  • A Keycloak account with admin privileges.

  • A realm for orcharhino user accounts created in Keycloak.

  • If the certificates or the CA are self-signed, ensure that they are added to the end-user certificate trust store.

  • Users imported or added to Keycloak.

    If you have an existing user database configured such as LDAP or Kerberos, you can import users from it by configuring user federation.

    If you do not have an existing user database configured, you can manually create users in Keycloak.

5.9.2. Registering orcharhino as a Keycloak client

Use this procedure to register orcharhino to Keycloak as a client and configure orcharhino to use Keycloak as an authentication source.

You can configure orcharhino and Keycloak with one of these authentication methods:

  1. Users authenticate to orcharhino using the orcharhino management UI.

  2. Users authenticate to orcharhino using the orcharhino CLI.

Note

Keycloak users cannot use both orcharhino management UI and Hammer CLI authentication in orcharhino at the same time.

You must decide on how you want your users to authenticate in advance because both methods require different orcharhino clients to be registered to Keycloak and configured. The steps to register and configure orcharhino client in Keycloak are distinguished within the procedure.

Procedure
  1. On orcharhino Server, install the following packages:

    # dnf install mod_auth_openidc keycloak-httpd-client-install python3-lxml
  2. Register orcharhino to Keycloak as a client. Note that you the registration process for logging in using the web UI and the CLI are different.

    • If you want you users to authenticate to orcharhino using the web UI, create a client as follows:

      # keycloak-httpd-client-install --app-name foreman-openidc \
      --keycloak-server-url "https://Keycloak.example.com" \
      --keycloak-admin-username "admin" \
      --keycloak-realm "orcharhino_Realm" \
      --keycloak-admin-realm master \
      --keycloak-auth-role root-admin \
      -t openidc -l /users/extlogin --force

      Enter the password for the administer account when prompted. This command creates a client for orcharhino in Keycloak.

      Then, configure orcharhino to use Keycloak as an authentication source:

      # foreman-installer --foreman-keycloak true \
      --foreman-keycloak-app-name "foreman-openidc" \
      --foreman-keycloak-realm "orcharhino_Realm"
    • If you want your users to authenticate to orcharhino using the CLI, create a client as follows:

      # keycloak-httpd-client-install --app-name hammer-openidc \
      --keycloak-server-url "https://Keycloak.example.com" \
      --keycloak-admin-username "admin" \
      --keycloak-realm "orcharhino_Realm" \
      --keycloak-admin-realm master \
      --keycloak-auth-role root-admin \
      -t openidc -l /users/extlogin --force

      Enter the password for the administer account when prompted. This command creates a client for orcharhino in Keycloak.

  3. Restart the httpd service:

    # systemctl restart httpd

5.9.3. Configuring the orcharhino client in Keycloak

Use this procedure to configure the orcharhino client in the Keycloak web UI and create group and audience mappers for the orcharhino client.

Procedure
  1. In the Keycloak web UI, navigate to Clients and click the orcharhino client.

  2. Configure access type:

    • If you want your users to authenticate to orcharhino using the orcharhino management UI, from the Access Type list, select confidential.

    • If you want your users to authenticate to orcharhino using the CLI, from the Access Type list, select public.

  3. In the Valid redirect URI fields, add a valid redirect URI.

    • If you want your users to authenticate to orcharhino using the orcharhino management UI, in the blank field below the existing URI, enter a URI in the form https://orcharhino.example.com/users/extlogin. Note that you must add the string /users/extlogin after the orcharhino FQDN.

      After completing this step, the orcharhino client for logging in using the orcharhino management UI must have the following Valid Redirect URIs:

      https://orcharhino.example.com/users/extlogin/redirect_uri
      https://orcharhino.example.com/users/extlogin
    • If you want your users to authenticate to orcharhino using the CLI, in the blank field below the existing URI, enter urn:ietf:wg:oauth:2.0:oob.

      After completing this step, the orcharhino client for logging in using the CLI must have the following Valid Redirect URIs:

      https://orcharhino.example.com/users/extlogin/redirect_uri
      urn:ietf:wg:oauth:2.0:oob
  4. Click Save.

  5. Click the Mappers tab and click Create to add an audience mapper.

  6. In the Name field, enter a name for the audience mapper.

  7. From the Mapper Type list, select Audience.

  8. From the Included Client Audience list, select the orcharhino client.

  9. Click Save.

  10. Click Create to add a group mapper so that you can specify authorization in orcharhino based on group membership.

  11. In the Name field, enter a name for the group mapper.

  12. From the Mapper Type list, select Group Membership.

  13. In the Token Claim Name field, enter groups.

  14. Set the Full group path setting to OFF.

  15. Click Save.

5.9.4. Configuring orcharhino settings for Keycloak authentication

Use this section to configure orcharhino for Keycloak authentication using the orcharhino management UI or the CLI.

Configuring orcharhino settings for Keycloak authentication using the web UI

Use this procedure to configure orcharhino settings for Keycloak authentication using the orcharhino management UI.

Note that you can navigate to the following URL within your realm to obtain values to configure orcharhino settings: https://Keycloak.example.com/auth/realms/orcharhino_Realm/.well-known/openid-configuration

Prerequisites
  • Ensure that the Access Type setting in the orcharhino client in the Keycloak web UI is set to confidential

Procedure
  1. In the orcharhino management UI, navigate to Administer > Settings, and click the Authentication tab.

  2. Locate the Authorize login delegation row, and in the Value column, set the value to Yes.

  3. Locate the Authorize login delegation auth source user autocreate row, and in the Value column, set the value to External.

  4. Locate the Login delegation logout URL row, and in the Value column, set the value to https://orcharhino.example.com/users/extlogout.

  5. Locate the OIDC Algorithm row, and in the Value column, set the algorithm for encoding on Keycloak to RS256.

  6. Locate the OIDC Audience row, and in the Value column, set the value to the client ID for Keycloak.

  7. Locate the OIDC Issuer row, and in the Value column, set the value to https://Keycloak.example.com/auth/realms/orcharhino_Realm.

  8. Locate the OIDC JWKs URL row, and in the Value column, set the value to https://Keycloak.example.com/auth/realms/orcharhino_Realm/protocol/openid-connect/certs.

  9. In the orcharhino management UI, navigate to Administer > Authentication Sources, click the vertical ellipsis on the External card, and select Edit.

  10. Click the Locations tab and add locations that can use the Keycloak authentication source.

  11. Click the Organizations tab and add organizations that can use the Keycloak authentication source.

  12. Click Submit.

Configuring orcharhino settings for Keycloak authentication using the CLI

Use this procedure to configure orcharhino settings for Keycloak authentication using the orcharhino CLI.

Note that you can navigate to the following URL within your realm to obtain values to configure orcharhino settings: https://Keycloak.example.com/auth/realms/orcharhino_Realm/.well-known/openid-configuration

Prerequisites
  • Ensure that the Access Type setting in the orcharhino client in the Keycloak web UI is set to public

Procedure
  1. On orcharhino, set the login delegation to true so that users can authenticate using the Open IDC protocol:

    # hammer settings set --name authorize_login_delegation --value true
  2. Set the login delegation logout URL:

    # hammer settings set --name login_delegation_logout_url \
    --value https://orcharhino.example.com/users/extlogout
  3. Set the algorithm for encoding on Keycloak, for example, RS256:

    # hammer settings set --name oidc_algorithm --value 'RS256'
  4. Open the Keycloak.example.com/auth/realms/Keycloak_REALM/.well-known/openid-configuration URL and note the values to populate the options in the following steps.

  5. Add the value for the Hammer client in the Open IDC audience:

    # hammer settings set --name oidc_audience \
    --value "['orcharhino.example.com-hammer-openidc']"
  6. Set the value for the Open IDC issuer:

    # hammer settings set --name oidc_issuer \
    --value "Keycloak.example.com/auth/realms/Keycloak_Realm"
  7. Set the value for Open IDC Java Web Token (JWT):

    # hammer settings set --name oidc_jwks_url \
    --value "Keycloak.example.com/auth/realms/Keycloak_Realm/protocol/openid-connect/certs"
  8. Retrieve the ID of the Keycloak authentication source:

    # hammer auth-source external list
  9. Set the location and organization:

    # hammer auth-source external update --id Authentication Source ID \
    --location-ids Location ID --organization-ids Organization ID

5.9.5. Logging in to the orcharhino management UI using Keycloak

Use this procedure to log in to the orcharhino management UI using Keycloak.

Procedure
  • In your browser, log in to orcharhino and enter your credentials.

5.9.6. Logging in to the orcharhino CLI using Keycloak

Use this procedure to authenticate to the orcharhino CLI using the code grant type.

Procedure
  1. To authenticate to the orcharhino CLI using the code grant type, enter the following command:

    # hammer auth login oauth \
    --two-factor \
    --oidc-token-endpoint 'https://Keycloak.example.com/auth/realms/ssl-realm/protocol/openid-connect/token' \
    --oidc-authorization-endpoint 'https://Keycloak.example.com/auth' \
    --oidc-client-id 'orcharhino.example.com-foreman-openidc' \
    --oidc-redirect-uri urn:ietf:wg:oauth:2.0:oob

    The command prompts you to enter a success code.

  2. To retrieve the success code, navigate to the URL that the command returns and provide the required information.

  3. Copy the success code that the web UI returns.

  4. In the command prompt of hammer auth login oauth, enter the success code to authenticate to the orcharhino CLI.

5.9.7. Configuring group mapping for Keycloak authentication

Optionally, to implement the Role Based Access Control (RBAC), create a group in orcharhino, assign a role to this group, and then map an Active Directory group to the orcharhino group. As a result, anyone in the given group in Keycloak are logged in under the corresponding orcharhino group. This example configures users of the orcharhino-admin user group in the Active Directory to authenticate as users with administrator privileges on orcharhino.

Procedure
  1. In the orcharhino management UI, navigate to Administer > User Groups.

  2. Click Create User Group.

  3. In the Name field, enter a name for the user group. The name should not be the same as in the Active Directory.

  4. Do not add users and user groups to the right-hand columns. Click the Roles tab.

  5. Select the Administer checkbox.

  6. Click the External Groups tab.

  7. Click Add external user group.

  8. In the Name field, enter the name of the Active Directory group.

  9. From the list, select EXTERNAL.

5.10. Configuring Keycloak authentication with TOTP

Use this section to configure orcharhino to use Keycloak as an OpenID provider for external authentication with TOTP cards.

5.10.1. Prerequisites for configuring orcharhino with Keycloak authentication

Before configuring orcharhino with Keycloak external authentication, ensure that you meet the following requirements:

  • A working installation of Keycloak server that uses HTTPS instead of HTTP.

  • A Keycloak account with admin privileges.

  • A realm for orcharhino user accounts created in Keycloak.

  • If the certificates or the CA are self-signed, ensure that they are added to the end-user certificate trust store.

  • Users imported or added to Keycloak.

    If you have an existing user database configured such as LDAP or Kerberos, you can import users from it by configuring user federation.

    If you do not have an existing user database configured, you can manually create users in Keycloak.

5.10.2. Registering orcharhino as a Keycloak client

Use this procedure to register orcharhino to Keycloak as a client and configure orcharhino to use Keycloak as an authentication source.

You can configure orcharhino and Keycloak with one of these authentication methods:

  1. Users authenticate to orcharhino using the orcharhino management UI.

  2. Users authenticate to orcharhino using the orcharhino CLI.

Note

Keycloak users cannot use both orcharhino management UI and Hammer CLI authentication in orcharhino at the same time.

You must decide on how you want your users to authenticate in advance because both methods require different orcharhino clients to be registered to Keycloak and configured. The steps to register and configure orcharhino client in Keycloak are distinguished within the procedure.

Procedure
  1. On orcharhino Server, install the following packages:

    # dnf install mod_auth_openidc keycloak-httpd-client-install python3-lxml
  2. Register orcharhino to Keycloak as a client. Note that you the registration process for logging in using the web UI and the CLI are different.

    • If you want you users to authenticate to orcharhino using the web UI, create a client as follows:

      # keycloak-httpd-client-install --app-name foreman-openidc \
      --keycloak-server-url "https://Keycloak.example.com" \
      --keycloak-admin-username "admin" \
      --keycloak-realm "orcharhino_Realm" \
      --keycloak-admin-realm master \
      --keycloak-auth-role root-admin \
      -t openidc -l /users/extlogin --force

      Enter the password for the administer account when prompted. This command creates a client for orcharhino in Keycloak.

      Then, configure orcharhino to use Keycloak as an authentication source:

      # foreman-installer --foreman-keycloak true \
      --foreman-keycloak-app-name "foreman-openidc" \
      --foreman-keycloak-realm "orcharhino_Realm"
    • If you want your users to authenticate to orcharhino using the CLI, create a client as follows:

      # keycloak-httpd-client-install --app-name hammer-openidc \
      --keycloak-server-url "https://Keycloak.example.com" \
      --keycloak-admin-username "admin" \
      --keycloak-realm "orcharhino_Realm" \
      --keycloak-admin-realm master \
      --keycloak-auth-role root-admin \
      -t openidc -l /users/extlogin --force

      Enter the password for the administer account when prompted. This command creates a client for orcharhino in Keycloak.

  3. Restart the httpd service:

    # systemctl restart httpd

5.10.3. Configuring the orcharhino client in Keycloak

Use this procedure to configure the orcharhino client in the Keycloak web UI and create group and audience mappers for the orcharhino client.

Procedure
  1. In the Keycloak web UI, navigate to Clients and click the orcharhino client.

  2. Configure access type:

    • If you want your users to authenticate to orcharhino using the orcharhino management UI, from the Access Type list, select confidential.

    • If you want your users to authenticate to orcharhino using the CLI, from the Access Type list, select public.

  3. In the Valid redirect URI fields, add a valid redirect URI.

    • If you want your users to authenticate to orcharhino using the orcharhino management UI, in the blank field below the existing URI, enter a URI in the form https://orcharhino.example.com/users/extlogin. Note that you must add the string /users/extlogin after the orcharhino FQDN.

      After completing this step, the orcharhino client for logging in using the orcharhino management UI must have the following Valid Redirect URIs:

      https://orcharhino.example.com/users/extlogin/redirect_uri
      https://orcharhino.example.com/users/extlogin
    • If you want your users to authenticate to orcharhino using the CLI, in the blank field below the existing URI, enter urn:ietf:wg:oauth:2.0:oob.

      After completing this step, the orcharhino client for logging in using the CLI must have the following Valid Redirect URIs:

      https://orcharhino.example.com/users/extlogin/redirect_uri
      urn:ietf:wg:oauth:2.0:oob
  4. Click Save.

  5. Click the Mappers tab and click Create to add an audience mapper.

  6. In the Name field, enter a name for the audience mapper.

  7. From the Mapper Type list, select Audience.

  8. From the Included Client Audience list, select the orcharhino client.

  9. Click Save.

  10. Click Create to add a group mapper so that you can specify authorization in orcharhino based on group membership.

  11. In the Name field, enter a name for the group mapper.

  12. From the Mapper Type list, select Group Membership.

  13. In the Token Claim Name field, enter groups.

  14. Set the Full group path setting to OFF.

  15. Click Save.

5.10.4. Configuring orcharhino settings for Keycloak authentication

Use this section to configure orcharhino for Keycloak authentication using the orcharhino management UI or the CLI.

Configuring orcharhino settings for Keycloak authentication using the web UI

Use this procedure to configure orcharhino settings for Keycloak authentication using the orcharhino management UI.

Note that you can navigate to the following URL within your realm to obtain values to configure orcharhino settings: https://Keycloak.example.com/auth/realms/orcharhino_Realm/.well-known/openid-configuration

Prerequisites
  • Ensure that the Access Type setting in the orcharhino client in the Keycloak web UI is set to confidential

Procedure
  1. In the orcharhino management UI, navigate to Administer > Settings, and click the Authentication tab.

  2. Locate the Authorize login delegation row, and in the Value column, set the value to Yes.

  3. Locate the Authorize login delegation auth source user autocreate row, and in the Value column, set the value to External.

  4. Locate the Login delegation logout URL row, and in the Value column, set the value to https://orcharhino.example.com/users/extlogout.

  5. Locate the OIDC Algorithm row, and in the Value column, set the algorithm for encoding on Keycloak to RS256.

  6. Locate the OIDC Audience row, and in the Value column, set the value to the client ID for Keycloak.

  7. Locate the OIDC Issuer row, and in the Value column, set the value to https://Keycloak.example.com/auth/realms/orcharhino_Realm.

  8. Locate the OIDC JWKs URL row, and in the Value column, set the value to https://Keycloak.example.com/auth/realms/orcharhino_Realm/protocol/openid-connect/certs.

  9. In the orcharhino management UI, navigate to Administer > Authentication Sources, click the vertical ellipsis on the External card, and select Edit.

  10. Click the Locations tab and add locations that can use the Keycloak authentication source.

  11. Click the Organizations tab and add organizations that can use the Keycloak authentication source.

  12. Click Submit.

Configuring orcharhino settings for Keycloak authentication using the CLI

Use this procedure to configure orcharhino settings for Keycloak authentication using the orcharhino CLI.

Note that you can navigate to the following URL within your realm to obtain values to configure orcharhino settings: https://Keycloak.example.com/auth/realms/orcharhino_Realm/.well-known/openid-configuration

Prerequisites
  • Ensure that the Access Type setting in the orcharhino client in the Keycloak web UI is set to public

Procedure
  1. On orcharhino, set the login delegation to true so that users can authenticate using the Open IDC protocol:

    # hammer settings set --name authorize_login_delegation --value true
  2. Set the login delegation logout URL:

    # hammer settings set --name login_delegation_logout_url \
    --value https://orcharhino.example.com/users/extlogout
  3. Set the algorithm for encoding on Keycloak, for example, RS256:

    # hammer settings set --name oidc_algorithm --value 'RS256'
  4. Open the Keycloak.example.com/auth/realms/Keycloak_REALM/.well-known/openid-configuration URL and note the values to populate the options in the following steps.

  5. Add the value for the Hammer client in the Open IDC audience:

    # hammer settings set --name oidc_audience \
    --value "['orcharhino.example.com-hammer-openidc']"
  6. Set the value for the Open IDC issuer:

    # hammer settings set --name oidc_issuer \
    --value "Keycloak.example.com/auth/realms/Keycloak_Realm"
  7. Set the value for Open IDC Java Web Token (JWT):

    # hammer settings set --name oidc_jwks_url \
    --value "Keycloak.example.com/auth/realms/Keycloak_Realm/protocol/openid-connect/certs"
  8. Retrieve the ID of the Keycloak authentication source:

    # hammer auth-source external list
  9. Set the location and organization:

    # hammer auth-source external update --id Authentication Source ID \
    --location-ids Location ID --organization-ids Organization ID

5.10.5. Configuring orcharhino with Keycloak for TOTP authentication

Use this procedure to configure orcharhino to use Keycloak as an OpenID provider for external authentication with Time-based One-time Password (TOTP).

Procedure
  1. In the Keycloak web UI, navigate to the orcharhino realm.

  2. Navigate to Authentication, and click the OTP Policy tab.

  3. Ensure that the Supported Applications field includes FreeOTP or Google Authenticator.

  4. Configure the OTP settings to suit your requirements.

  5. Optional: If you want to use TOTP authentication as a default authentication method for all users, click the Flows tab, and to the right of the OTP Form setting, select REQUIRED.

  6. Click the Required Actions tab.

  7. To the right of the Configure OTP row, select the Default Action checkbox.

5.10.6. Logging in to the orcharhino management UI using Keycloak TOTP authentication

Use this procedure to log in to the orcharhino management UI using Keycloak TOTP authentication.

Procedure
  1. Log in to orcharhino, orcharhino redirects you to the Keycloak login screen.

  2. Enter your username and password, and click Log In.

  3. The first attempt to log in, Keycloak requests you to configure your client by scanning the barcode and entering the pin displayed.

  4. After you configure your client and enter a valid PIN, Keycloak redirects you to orcharhino and logs you in.

5.10.7. Logging in to the orcharhino CLI using Keycloak

Use this procedure to authenticate to the orcharhino CLI using the code grant type.

Procedure
  1. To authenticate to the orcharhino CLI using the code grant type, enter the following command:

    # hammer auth login oauth \
    --two-factor \
    --oidc-token-endpoint 'https://Keycloak.example.com/auth/realms/ssl-realm/protocol/openid-connect/token' \
    --oidc-authorization-endpoint 'https://Keycloak.example.com/auth' \
    --oidc-client-id 'orcharhino.example.com-foreman-openidc' \
    --oidc-redirect-uri urn:ietf:wg:oauth:2.0:oob

    The command prompts you to enter a success code.

  2. To retrieve the success code, navigate to the URL that the command returns and provide the required information.

  3. Copy the success code that the web UI returns.

  4. In the command prompt of hammer auth login oauth, enter the success code to authenticate to the orcharhino CLI.

5.10.8. Configuring group mapping for Keycloak authentication

Optionally, to implement the Role Based Access Control (RBAC), create a group in orcharhino, assign a role to this group, and then map an Active Directory group to the orcharhino group. As a result, anyone in the given group in Keycloak are logged in under the corresponding orcharhino group. This example configures users of the orcharhino-admin user group in the Active Directory to authenticate as users with administrator privileges on orcharhino.

Procedure
  1. In the orcharhino management UI, navigate to Administer > User Groups.

  2. Click Create User Group.

  3. In the Name field, enter a name for the user group. The name should not be the same as in the Active Directory.

  4. Do not add users and user groups to the right-hand columns. Click the Roles tab.

  5. Select the Administer checkbox.

  6. Click the External Groups tab.

  7. Click Add external user group.

  8. In the Name field, enter the name of the Active Directory group.

  9. From the list, select EXTERNAL.

6. Configuring orcharhino Server with external services

If you do not want to configure the DNS, DHCP, and TFTP services on orcharhino Server, use this section to configure your orcharhino Server to work with external DNS, DHCP, and TFTP services.

6.1. Configuring orcharhino Server with external DNS

You can configure orcharhino Server with external DNS. orcharhino Server uses the nsupdate utility to update DNS records on the remote server.

To make any changes persistent, you must enter the foreman-installer command with the options appropriate for your environment.

Prerequisites
  • You must have a configured external DNS server.

  • This guide assumes you have an existing installation.

Procedure
  1. Copy the /etc/rndc.key file from the external DNS server to orcharhino Server:

    # scp root@dns.example.com:/etc/rndc.key /etc/foreman-proxy/rndc.key
  2. Configure the ownership, permissions, and SELinux context:

    # restorecon -v /etc/foreman-proxy/rndc.key
    # chown -v root:foreman-proxy /etc/foreman-proxy/rndc.key
    # chmod -v 640 /etc/foreman-proxy/rndc.key
  3. To test the nsupdate utility, add a host remotely:

    # echo -e "server DNS_IP_Address\n \
    update add aaa.example.com 3600 IN A Host_IP_Address\n \
    send\n" | nsupdate -k /etc/foreman-proxy/rndc.key
    # nslookup aaa.example.com DNS_IP_Address
    # echo -e "server DNS_IP_Address\n \
    update delete aaa.example.com 3600 IN A Host_IP_Address\n \
    send\n" | nsupdate -k /etc/foreman-proxy/rndc.key
  4. Enter the foreman-installer command to make the following persistent changes to the /etc/foreman-proxy/settings.d/dns.yml file:

    # foreman-installer --foreman-proxy-dns=true \
    --foreman-proxy-dns-managed=false \
    --foreman-proxy-dns-provider=nsupdate \
    --foreman-proxy-dns-server="DNS_IP_Address" \
    --foreman-proxy-keyfile=/etc/foreman-proxy/rndc.key
  5. In the orcharhino management UI, navigate to Infrastructure > orcharhino Proxies.

  6. Locate the orcharhino Server and select Refresh from the list in the Actions column.

  7. Associate the DNS service with the appropriate subnets and domain.

6.2. Configuring orcharhino Server with external DHCP

To configure orcharhino Server with external DHCP, you must complete the following procedures:

6.2.1. Configuring an external DHCP server to use with orcharhino Server

To configure an external DHCP server running Enterprise Linux to use with orcharhino Server, you must install the ISC DHCP Service and Berkeley Internet Name Domain (BIND) utilities packages. You must also share the DHCP configuration and lease files with orcharhino Server. The example in this procedure uses the distributed Network File System (NFS) protocol to share the DHCP configuration and lease files.

Note

If you use dnsmasq as an external DHCP server, enable the dhcp-no-override setting. This is required because orcharhino creates configuration files on the TFTP server under the grub2/ subdirectory. If the dhcp-no-override setting is disabled, hosts fetch the bootloader and its configuration from the root directory, which might cause an error.

Procedure
  1. On your Enterprise Linux host, install the ISC DHCP Service and Berkeley Internet Name Domain (BIND) utilities packages:

    # dnf install dhcp-server bind-utils
  2. Generate a security token:

    # tsig-keygen -a hmac-md5 omapi_key
  3. Edit the dhcpd configuration file for all subnets and add the key generated by tsig-keygen. The following is an example:

    # cat /etc/dhcp/dhcpd.conf
    default-lease-time 604800;
    max-lease-time 2592000;
    log-facility local7;
    
    subnet 192.168.38.0 netmask 255.255.255.0 {
    	range 192.168.38.10 192.168.38.100;
    	option routers 192.168.38.1;
    	option subnet-mask 255.255.255.0;
    	option domain-search "virtual.lan";
    	option domain-name "virtual.lan";
    	option domain-name-servers 8.8.8.8;
    }
    
    omapi-port 7911;
    key omapi_key {
    	algorithm hmac-md5;
    	secret "My_Secret";
    };
    omapi-key omapi_key;

    Note that the option routers value is the IP address of your orcharhino Server or orcharhino Proxy that you want to use with an external DHCP service.

  4. On orcharhino Server, define each subnet. Do not set DHCP orcharhino Proxy for the defined Subnet yet.

    To prevent conflicts, set up the lease and reservation ranges separately. For example, if the lease range is 192.168.38.10 to 192.168.38.100, in the orcharhino management UI define the reservation range as 192.168.38.101 to 192.168.38.250.

  5. Configure the firewall for external access to the DHCP server:

    # firewall-cmd --add-service dhcp
  6. Make the changes persistent:

    # firewall-cmd --runtime-to-permanent
  7. On orcharhino Server, determine the UID and GID of the foreman user:

    # id -u foreman
    993
    # id -g foreman
    990
  8. On the DHCP server, create the foreman user and group with the same IDs as determined in a previous step:

    # groupadd -g 990 foreman
    # useradd -u 993 -g 990 -s /sbin/nologin foreman
  9. To ensure that the configuration files are accessible, restore the read and execute flags:

    # chmod o+rx /etc/dhcp/
    # chmod o+r /etc/dhcp/dhcpd.conf
    # chattr +i /etc/dhcp/ /etc/dhcp/dhcpd.conf
  10. Enable and start the DHCP service:

    # systemctl enable --now dhcpd
  11. Export the DHCP configuration and lease files using NFS:

    # dnf install nfs-utils
    # systemctl enable --now nfs-server
  12. Create directories for the DHCP configuration and lease files that you want to export using NFS:

    # mkdir -p /exports/var/lib/dhcpd /exports/etc/dhcp
  13. To create mount points for the created directories, add the following line to the /etc/fstab file:

    /var/lib/dhcpd /exports/var/lib/dhcpd none bind,auto 0 0
    /etc/dhcp /exports/etc/dhcp none bind,auto 0 0
  14. Mount the file systems in /etc/fstab:

    # mount -a
  15. Ensure the following lines are present in /etc/exports:

    /exports 192.168.38.1(rw,async,no_root_squash,fsid=0,no_subtree_check)
    
    /exports/etc/dhcp 192.168.38.1(ro,async,no_root_squash,no_subtree_check,nohide)
    
    /exports/var/lib/dhcpd 192.168.38.1(ro,async,no_root_squash,no_subtree_check,nohide)

    Note that the IP address that you enter is the orcharhino or orcharhino Proxy IP address that you want to use with an external DHCP service.

  16. Reload the NFS server:

    # exportfs -rva
  17. Configure the firewall for DHCP omapi port 7911:

    # firewall-cmd --add-port=7911/tcp
  18. Optional: Configure the firewall for external access to NFS. Clients are configured using NFSv3.

    # firewall-cmd \
    --add-service mountd \
    --add-service nfs \
    --add-service rpc-bind \
    --zone public
  19. Make the changes persistent:

    # firewall-cmd --runtime-to-permanent

6.2.2. Configuring orcharhino Server with an external DHCP server

You can configure orcharhino Server with an external DHCP server.

Prerequisites
Procedure
  1. Install the nfs-utils package:

    # dnf install nfs-utils
  2. Create the DHCP directories for NFS:

    # mkdir -p /mnt/nfs/etc/dhcp /mnt/nfs/var/lib/dhcpd
  3. Change the file owner:

    # chown -R foreman-proxy /mnt/nfs
  4. Verify communication with the NFS server and the Remote Procedure Call (RPC) communication paths:

    # showmount -e DHCP_Server_FQDN
    # rpcinfo -p DHCP_Server_FQDN
  5. Add the following lines to the /etc/fstab file:

    DHCP_Server_FQDN:/exports/etc/dhcp /mnt/nfs/etc/dhcp nfs
    ro,vers=3,auto,nosharecache,context="system_u:object_r:dhcp_etc_t:s0" 0 0
    
    DHCP_Server_FQDN:/exports/var/lib/dhcpd /mnt/nfs/var/lib/dhcpd nfs
    ro,vers=3,auto,nosharecache,context="system_u:object_r:dhcpd_state_t:s0" 0 0
  6. Mount the file systems on /etc/fstab:

    # mount -a
  7. To verify that the foreman-proxy user can access the files that are shared over the network, display the DHCP configuration and lease files:

    # su foreman-proxy -s /bin/bash
    $ cat /mnt/nfs/etc/dhcp/dhcpd.conf
    $ cat /mnt/nfs/var/lib/dhcpd/dhcpd.leases
    $ exit
  8. Enter the foreman-installer command to make the following persistent changes to the /etc/foreman-proxy/settings.d/dhcp.yml file:

    # foreman-installer \
    --enable-foreman-proxy-plugin-dhcp-remote-isc \
    --foreman-proxy-dhcp-provider=remote_isc \
    --foreman-proxy-dhcp-server=My_DHCP_Server_FQDN \
    --foreman-proxy-dhcp=true \
    --foreman-proxy-plugin-dhcp-remote-isc-dhcp-config /mnt/nfs/etc/dhcp/dhcpd.conf \
    --foreman-proxy-plugin-dhcp-remote-isc-dhcp-leases /mnt/nfs/var/lib/dhcpd/dhcpd.leases \
    --foreman-proxy-plugin-dhcp-remote-isc-key-name=omapi_key \
    --foreman-proxy-plugin-dhcp-remote-isc-key-secret=My_Secret \
    --foreman-proxy-plugin-dhcp-remote-isc-omapi-port=7911
  9. Associate the DHCP service with the appropriate subnets and domain.

6.3. Configuring orcharhino Server with external TFTP

You can configure orcharhino Server with external TFTP services.

Procedure
  1. Create the TFTP directory for NFS:

    # mkdir -p /mnt/nfs/var/lib/tftpboot
  2. In the /etc/fstab file, add the following line:

    TFTP_Server_IP_Address:/exports/var/lib/tftpboot /mnt/nfs/var/lib/tftpboot nfs rw,vers=3,auto,nosharecache,context="system_u:object_r:tftpdir_rw_t:s0" 0 0
  3. Mount the file systems in /etc/fstab:

    # mount -a
  4. Enter the foreman-installer command to make the following persistent changes to the /etc/foreman-proxy/settings.d/tftp.yml file:

    # foreman-installer \
    --foreman-proxy-tftp-root /mnt/nfs/var/lib/tftpboot \
    --foreman-proxy-tftp=true
  5. If the TFTP service is running on a different server than the DHCP service, update the tftp_servername setting with the FQDN or IP address of the server that the TFTP service is running on:

    # foreman-installer --foreman-proxy-tftp-servername=TFTP_Server_FQDN
  6. In the orcharhino management UI, navigate to Infrastructure > orcharhino Proxies.

  7. Locate the orcharhino Server and select Refresh from the list in the Actions column.

  8. Associate the TFTP service with the appropriate subnets and domain.

6.4. Configuring orcharhino Server with external IdM DNS

When orcharhino Server adds a DNS record for a host, it first determines which orcharhino Proxy is providing DNS for that domain. It then communicates with the orcharhino Proxy that is configured to provide DNS service for your deployment and adds the record. The hosts are not involved in this process. Therefore, you must install and configure the IdM client on the orcharhino or orcharhino Proxy that is currently configured to provide a DNS service for the domain you want to manage using the IdM server.

orcharhino Server can be configured to use a Red Hat Identity Management (IdM) server to provide DNS service.

To configure orcharhino Server to use a Red Hat Identity Management (IdM) server to provide DNS service, use one of the following procedures:

To revert to internal DNS service, use the following procedure:

Note
You are not required to use orcharhino Server to manage DNS. When you are using the realm enrollment feature of orcharhino, where provisioned hosts are enrolled automatically to IdM, the ipa-client-install script creates DNS records for the client. Configuring orcharhino Server with external IdM DNS and realm enrollment are mutually exclusive. For more information about configuring realm enrollment, see External authentication for provisioned hosts.

6.4.1. Configuring dynamic DNS update with GSS-TSIG authentication

You can configure the IdM server to use the generic security service algorithm for secret key transaction (GSS-TSIG) technology defined in RFC3645. To configure the IdM server to use the GSS-TSIG technology, you must install the IdM client on the orcharhino Server base operating system.

Prerequisites
  • You must ensure the IdM server is deployed and the host-based firewall is configured correctly.

  • You must contact the IdM server administrator to ensure that you obtain an account on the IdM server with permissions to create zones on the IdM server.

  • You should create a backup of the answer file. You can use the backup to restore the answer file to its original state if it becomes corrupted. For more information, see Configuring orcharhino Server.

Procedure

To configure dynamic DNS update with GSS-TSIG authentication, complete the following steps:

Creating a Kerberos principal on the IdM server
  1. Obtain a Kerberos ticket for the account obtained from the IdM administrator:

    # kinit idm_user
  2. Create a new Kerberos principal for orcharhino Server to use to authenticate on the IdM server:

    # ipa service-add orcharhinoproxy/orcharhino.example.com
Installing and configuring the idM client
  1. On the base operating system of either the orcharhino or orcharhino Proxy that is managing the DNS service for your deployment, install the ipa-client package:

    # dnf install ipa-client
  2. Configure the IdM client by running the installation script and following the on-screen prompts:

    # ipa-client-install
  3. Obtain a Kerberos ticket:

    # kinit admin
  4. Remove any preexisting keytab:

    # rm /etc/foreman-proxy/dns.keytab
  5. Obtain the keytab for this system:

    # ipa-getkeytab -p orcharhinoproxy/orcharhino.example.com@EXAMPLE.COM \
    -s idm1.example.com -k /etc/foreman-proxy/dns.keytab
    Note

    When adding a keytab to a standby system with the same host name as the original system in service, add the r option to prevent generating new credentials and rendering the credentials on the original system invalid.

  6. For the dns.keytab file, set the group and owner to foreman-proxy:

    # chown foreman-proxy:foreman-proxy /etc/foreman-proxy/dns.keytab
  7. Optional: To verify that the keytab file is valid, enter the following command:

    # kinit -kt /etc/foreman-proxy/dns.keytab \
    orcharhinoproxy/orcharhino.example.com@EXAMPLE.COM
Configuring DNS zones in the IdM web UI
  1. Create and configure the zone that you want to manage:

    1. Navigate to Network Services > DNS > DNS Zones.

    2. Select Add and enter the zone name. For example, example.com.

    3. Click Add and Edit.

    4. Click the Settings tab and in the BIND update policy box, add the following to the semi-colon separated list:

      grant orcharhinoproxy\047orcharhino.example.com@EXAMPLE.COM wildcard * ANY;
    5. Set Dynamic update to True.

    6. Enable Allow PTR sync.

    7. Click Save to save the changes.

  2. Create and configure the reverse zone:

    1. Navigate to Network Services > DNS > DNS Zones.

    2. Click Add.

    3. Select Reverse zone IP network and add the network address in CIDR format to enable reverse lookups.

    4. Click Add and Edit.

    5. Click the Settings tab and in the BIND update policy box, add the following to the semi-colon separated list:

      grant orcharhinoproxy\047orcharhino.example.com@EXAMPLE.COM wildcard * ANY;
    6. Set Dynamic update to True.

    7. Click Save to save the changes.

Configuring the orcharhino or orcharhino Proxy that manages the DNS service for the domain
  1. Configure your orcharhino Server or orcharhino Proxy to connect to your DNS service:

    # foreman-installer \
    --foreman-proxy-dns-managed=false \
    --foreman-proxy-dns-provider=nsupdate_gss \
    --foreman-proxy-dns-server="idm1.example.com" \
    --foreman-proxy-dns-tsig-keytab=/etc/foreman-proxy/dns.keytab \
    --foreman-proxy-dns-tsig-principal="orcharhinoproxy/orcharhino.example.com@EXAMPLE.COM" \
    --foreman-proxy-dns=true
  2. For each affected orcharhino Proxy, update the configuration of that orcharhino Proxy in the orcharhino management UI:

    1. In the orcharhino management UI, navigate to Infrastructure > orcharhino Proxies, locate the orcharhino Server, and from the list in the Actions column, select Refresh.

    2. Configure the domain:

      1. In the orcharhino management UI, navigate to Infrastructure > Domains and select the domain name.

      2. In the Domain tab, ensure DNS orcharhino Proxy is set to the orcharhino Proxy where the subnet is connected.

    3. Configure the subnet:

      1. In the orcharhino management UI, navigate to Infrastructure > Subnets and select the subnet name.

      2. In the Subnet tab, set IPAM to None.

      3. In the Domains tab, select the domain that you want to manage using the IdM server.

      4. In the orcharhino Proxies tab, ensure Reverse DNS orcharhino Proxy is set to the orcharhino Proxy where the subnet is connected.

      5. Click Submit to save the changes.

6.4.2. Configuring dynamic DNS update with TSIG authentication

You can configure an IdM server to use the secret key transaction authentication for DNS (TSIG) technology that uses the rndc.key key file for authentication. The TSIG protocol is defined in RFC2845.

Prerequisites
  • You must ensure the IdM server is deployed and the host-based firewall is configured correctly.

  • You must obtain root user access on the IdM server.

  • You must confirm whether orcharhino Server or orcharhino Proxy is configured to provide DNS service for your deployment.

  • You must configure DNS, DHCP and TFTP services on the base operating system of either the orcharhino or orcharhino Proxy that is managing the DNS service for your deployment.

  • You must create a backup of the answer file. You can use the backup to restore the answer file to its original state if it becomes corrupted. For more information, see Configuring orcharhino Server.

Procedure

To configure dynamic DNS update with TSIG authentication, complete the following steps:

Enabling external updates to the DNS zone in the IdM server
  1. On the IdM Server, add the following to the top of the /etc/named.conf file:

    ########################################################################
    
    include "/etc/rndc.key";
    controls  {
    inet _IdM_Server_IP_Address_ port 953 allow { _orcharhino_IP_Address_; } keys { "rndc-key"; };
    };
    ########################################################################
  2. Reload the named service to make the changes take effect:

    # systemctl reload named
  3. In the IdM web UI, navigate to Network Services > DNS > DNS Zones and click the name of the zone. In the Settings tab, apply the following changes:

    1. Add the following in the BIND update policy box:

      grant "rndc-key" zonesub ANY;
    2. Set Dynamic update to True.

    3. Click Update to save the changes.

  4. Copy the /etc/rndc.key file from the IdM server to the base operating system of your orcharhino Server. Enter the following command:

    # scp /etc/rndc.key root@orcharhino.example.com:/etc/rndc.key
  5. To set the correct ownership, permissions, and SELinux context for the rndc.key file, enter the following command:

    # restorecon -v /etc/rndc.key
    # chown -v root:named /etc/rndc.key
    # chmod -v 640 /etc/rndc.key
  6. Assign the foreman-proxy user to the named group manually. Normally, foreman-installer ensures that the foreman-proxy user belongs to the named UNIX group, however, in this scenario orcharhino does not manage users and groups, therefore you need to assign the foreman-proxy user to the named group manually.

    # usermod -a -G named foreman-proxy
  7. On orcharhino Server, enter the following foreman-installer command to configure orcharhino to use the external DNS server:

    # foreman-installer \
    --foreman-proxy-dns-managed=false \
    --foreman-proxy-dns-provider=nsupdate \
    --foreman-proxy-dns-server="IdM_Server_IP_Address" \
    --foreman-proxy-dns-ttl=86400 \
    --foreman-proxy-dns=true \
    --foreman-proxy-keyfile=/etc/rndc.key
Testing external updates to the DNS zone in the IdM server
  1. Ensure that the key in the /etc/rndc.key file on orcharhino Server is the same key file that is used on the IdM server:

    key "rndc-key" {
            algorithm hmac-md5;
            secret "secret-key==";
    };
  2. On orcharhino Server, create a test DNS entry for a host. For example, host test.example.com with an A record of 192.168.25.20 on the IdM server at 192.168.25.1.

    # echo -e "server 192.168.25.1\n \
    update add test.example.com 3600 IN A 192.168.25.20\n \
    send\n" | nsupdate -k /etc/rndc.key
  3. On orcharhino Server, test the DNS entry:

    # nslookup test.example.com 192.168.25.1
    Server:		192.168.25.1
    Address:	192.168.25.1#53
    
    Name:	test.example.com
    Address: 192.168.25.20
  4. To view the entry in the IdM web UI, navigate to Network Services > DNS > DNS Zones. Click the name of the zone and search for the host by name.

  5. If resolved successfully, remove the test DNS entry:

    # echo -e "server 192.168.25.1\n \
    update delete test.example.com 3600 IN A 192.168.25.20\n \
    send\n" | nsupdate -k /etc/rndc.key
  6. Confirm that the DNS entry was removed:

    # nslookup test.example.com 192.168.25.1

    The above nslookup command fails and returns the SERVFAIL error message if the record was successfully deleted.

6.4.3. Reverting to internal DNS service

You can revert to using orcharhino Server and orcharhino Proxy as your DNS providers. You can use a backup of the answer file that was created before configuring external DNS, or you can create a backup of the answer file. For more information about answer files, see Configuring orcharhino Server.

Procedure

On the orcharhino or orcharhino Proxy that you want to configure to manage DNS service for the domain, complete the following steps:

Configuring orcharhino or orcharhino Proxy as a DNS server
  • If you have created a backup of the answer file before configuring external DNS, restore the answer file and then enter the foreman-installer command:

    # foreman-installer
  • If you do not have a suitable backup of the answer file, create a backup of the answer file now. To configure orcharhino or orcharhino Proxy as DNS server without using an answer file, enter the following foreman-installer command on orcharhino or orcharhino Proxy:

    # foreman-installer \
    --foreman-proxy-dns-managed=true \
    --foreman-proxy-dns-provider=nsupdate \
    --foreman-proxy-dns-server="127.0.0.1" \
    --foreman-proxy-dns=true

After you run the foreman-installer command to make any changes to your orcharhino Proxy configuration, you must update the configuration of each affected orcharhino Proxy in the orcharhino management UI.

Updating the configuration in the orcharhino management UI
  1. In the orcharhino management UI, navigate to Infrastructure > orcharhino Proxies.

  2. For each orcharhino Proxy that you want to update, from the Actions list, select Refresh.

  3. Configure the domain:

    1. In the orcharhino management UI, navigate to Infrastructure > Domains and click the domain name that you want to configure.

    2. In the Domain tab, set DNS orcharhino Proxy to the orcharhino Proxy where the subnet is connected.

  4. Configure the subnet:

    1. In the orcharhino management UI, navigate to Infrastructure > Subnets and select the subnet name.

    2. In the Subnet tab, set IPAM to DHCP or Internal DB.

    3. In the Domains tab, select the domain that you want to manage using orcharhino or orcharhino Proxy.

    4. In the orcharhino Proxies tab, set Reverse DNS orcharhino Proxy to the orcharhino Proxy where the subnet is connected.

    5. Click Submit to save the changes.

Appendix A: Troubleshooting DNF modules

If DNF modules fails to enable, it can mean an incorrect module is enabled. In that case, you have to resolve dependencies manually as follows. List the enabled modules:

# dnf module list --enabled

Ruby

If Ruby module fails to enable, it can mean an incorrect module is enabled. In that case, you have to resolve dependencies manually as follows:

List the enabled modules:

# dnf module list --enabled

If the Ruby 2.5 module has already been enabled, perform a module reset:

# dnf module reset ruby

PostgreSQL

If PostgreSQL module fails to enable, it can mean an incorrect module is enabled. In that case, you have to resolve dependencies manually as follows:

List the enabled modules:

# dnf module list --enabled

If the PostgreSQL 10 module has already been enabled, perform a module reset:

# dnf module reset postgresql

If a database was previously created using PostgreSQL 10, perform an upgrade:

  1. Enable the DNF modules:

    # dnf module enable orcharhino:el8
  2. Install the PostgreSQL upgrade package:

    # dnf install postgresql-upgrade
  3. Perform the upgrade:

    # postgresql-setup --upgrade

Appendix B: Applying custom configuration to orcharhino

When you install and configure orcharhino for the first time using foreman-installer, you can specify that the DNS and DHCP configuration files are not to be managed by Puppet using the installer flags --foreman-proxy-dns-managed=false and --foreman-proxy-dhcp-managed=false. If these flags are not specified during the initial installer run, rerunning of the installer overwrites all manual changes, for example, rerun for upgrade purposes. If changes are overwritten, you must run the restore procedure to restore the manual changes. For more information, see Restoring Manual Changes Overwritten by a Puppet Run.

To view all installer flags available for custom configuration, run foreman-installer --scenario katello --full-help. Some Puppet classes are not exposed to the orcharhino installer. To manage them manually and prevent the installer from overwriting their values, specify the configuration values by adding entries to configuration file /etc/foreman-installer/custom-hiera.yaml. This configuration file is in YAML format, consisting of one entry per line in the format of <puppet class>::<parameter name>: <value>. Configuration values specified in this file persist across installer reruns.

Common examples include:

  • For Apache, to set the ServerTokens directive to only return the Product name:

    apache::server_tokens: Prod
  • To turn off the Apache server signature entirely:

    apache::server_signature: Off

The Puppet modules for the orcharhino installer are stored under /usr/share/foreman-installer/modules. Check the .pp files (for example: moduleName/manifests/example.pp) to look up the classes, parameters, and values. Alternatively, use the grep command to do keyword searches.

Setting some values may have unintended consequences that affect the performance or functionality of orcharhino. Consider the impact of the changes before you apply them, and test the changes in a non-production environment first. If you do not have a non-production orcharhino environment, run the orcharhino installer with the --noop and --verbose options. If your changes cause problems, remove the offending lines from custom-hiera.yaml and rerun the orcharhino installer. If you have any specific questions about whether a particular value is safe to alter, contact Red Hat support.

Appendix C: Restoring manual changes overwritten by a Puppet run

If your manual configuration has been overwritten by a Puppet run, you can restore the files to the previous state. The following example shows you how to restore a DHCP configuration file overwritten by a Puppet run.

Procedure
  1. Copy the file you intend to restore. This allows you to compare the files to check for any mandatory changes required by the upgrade. This is not common for DNS or DHCP services.

    # cp /etc/dhcp/dhcpd.conf /etc/dhcp/dhcpd.backup
  2. Check the log files to note down the md5sum of the overwritten file. For example:

    # journalctl -xe
    ...
    /Stage[main]/Dhcp/File[/etc/dhcp/dhcpd.conf]: Filebucketed /etc/dhcp/dhcpd.conf to puppet with sum 622d9820b8e764ab124367c68f5fa3a1
    ...
  3. Restore the overwritten file:

    # puppet filebucket restore --local --bucket \
    /var/lib/puppet/clientbucket /etc/dhcp/dhcpd.conf \ 622d9820b8e764ab124367c68f5fa3a1
  4. Compare the backup file and the restored file, and edit the restored file to include any mandatory changes required by the upgrade.