1. Preparing your environment for installation

Review the following prerequisites before you install orcharhino Server.

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 in Red Hat Enterprise Linux 9 Configuring basic system settings.

orcharhino Server and orcharhino Proxy Server 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.

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 Server 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 Server 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. AWS Requirements

Installing and running orcharhino Server and orcharhino Proxy Servers on Amazon Web Services (AWS) has additional requirements to your environment.

Amazon Web Service requirements

  • Use Storage requirements in Installing orcharhino Server to understand and assign the correct storage to your AWS EBS volumes. See also an AWS storage optimized instance for further guidance.

  • Create EBS volumes for directories expected to contain larger amounts of data like /var/lib/pulp and ensure they are correctly mounted on start-up and before continuing the installation.

  • Optional: Store other data on a separate EBS volume.

  • If you want orcharhino Server and orcharhino Proxy Server to communicate using external DNS hostnames, open the required ports for communication in the AWS Security Group that is associated with the instance.

AWS permission requirements

  • Create and access Enterprise Linux images in AWS

  • Edit network access in AWS Security

  • Create EC2 instances and EBS volumes

  • Launch EC2 instances

  • Import and export of virtual machines in AWS

  • Usage of AWS Direct Connect

orcharhino requirements

Ensure that your Amazon EC2 instance meets or exceeds requirements for orcharhino:

Additional resources

1.7. 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 Configuring firewalls and packet filters.

1.8. 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.9. 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.10. 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 DHCPv6 server and configure it manually to communicate with the network boot process and to manage IP address assignment because orcharhino cannot integrate with a DHCPv6 server and manage its configuration. For more information about DHCPv6 server configuration, see Options in unmanaged DHCPv6 in Provisioning hosts.

  • 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 = http-proxy.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 Server 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 Server installations

In case of new orcharhino Server or orcharhino Proxy Server 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 Security hardening.

3.4. Installing orcharhino Server packages

3.5. Configuring orcharhino Server

Procedure

Install orcharhino Server by 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.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://http-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. Select the Default content HTTP proxy option to set the new HTTP proxy as default for content synchronization.

  9. Click Submit.

CLI procedure

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

    # unset http_proxy https_proxy no_proxy

  2. Add an HTTP proxy entry to orcharhino and set the HTTP proxy as default for content synchronization:

    $ hammer http-proxy create \
--name=My_HTTP_Proxy \
--username=My_HTTP_Proxy_User_Name \
--password=My_HTTP_Proxy_Password \
--url http://http-proxy.example.com:8080 \
--content-default-http-proxy true

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 your TFTP orcharhino Proxy, verify the ports that are permitted by SELinux for the HTTP cache by entering the following command:

    # systemctl edit foreman-proxy

  2. Configure the HTTP proxy in /etc/systemd/system/foreman-proxy.service.d/overrides.conf:

    [Service]
Environment="http_proxy=http://http-proxy.example.com:8080"
Environment="https_proxy=https://http-proxy.example.com:8443"

  3. Restart the foreman-proxy service:

    # systemctl restart foreman-proxy

  4. 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 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.6. Configuring orcharhino to manage the lifecycle of a host registered to a FreeIPA realm

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.

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

Prerequisites

  • orcharhino Server that is registered to the Content Delivery Network or your orcharhino Proxy Server 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 Server:

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

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

    # 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 Server 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 Server 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 Proxy Servers, 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 Server, 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 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 Server 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 Server 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.

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 My-Alternate-FQDN.example.com option to register the host to the alternate orcharhino CNAME:

# ./bootstrap.py --server My-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 = My-Alternate-FQDN.example.com

content omitted

[rhsm]
# Content base URL:
baseurl=https://My-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, orcharhino Proxy Servers, 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 Server.

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

  • 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 orcharhino Proxy Servers registered to orcharhino Server, configure them with custom SSL certificates. For more information, see Configuring orcharhino Proxy Server with a Custom SSL Certificate in Installing orcharhino Proxy Server.

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 Server.

    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:

Additional resources

4.10. Using external databases with orcharhino

The orcharhino installation process includes installing a PostgreSQL database on the same host as orcharhino Server. In certain orcharhino deployments, using external databases instead of the default local databases can help with the server load.

4.10.1. Configuring orcharhino Server with external database

Running the foreman-installer command, used to install a orcharhino Server, also installs PostgreSQL databases on the server. However, you can configure your orcharhino Server to use external databases instead. Moving to external databases distributes the workload and can reduce overall orcharhino memory usage.

Consider using external databases if you plan to use your orcharhino deployment for the following scenarios:

  • Frequent remote execution tasks. This requires a high volume of records in PostgreSQL and generates heavy database workloads.

  • High disk I/O workloads from frequent repository synchronization or content view publishing. This requires orcharhino to create a record in PostgreSQL for each job.

  • High volume of hosts.

  • High volume of synchronized content.

4.10.2. 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 13.

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.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 13.

Prerequisites

  • The prepared host must meet orcharhino Storage requirements.

  • The prepared host has base operating system repositories enabled.

Procedure

  1. On your new database server, install PostgreSQL:

    # dnf install postgresql-server postgresql-contrib

  2. Initialize the PostgreSQL database:

    # 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. Add the following line to the end of the file to use SCRAM for authentication:

    password_encryption=scram-sha-256

  6. Edit the /var/lib/pgsql/data/pg_hba.conf file:

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

  7. Add the following line to the file:

      host  all   all   orcharhino_ip/32   scram-sha-256

  8. Start and enable the PostgreSQL service:

    # systemctl enable --now postgresql

  9. Open the postgresql port:

    # firewall-cmd --add-service=postgresql

  10. Make the changes persistent:

    # firewall-cmd --runtime-to-permanent

  11. Switch to the postgres user and start the PostgreSQL client:

    $ su - postgres -c psql

  12. Create three databases and dedicated roles: one for Foreman, 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;

  13. Exit the postgres user:

    # \q

  14. 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

Appendix A: 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.

For example, when you install and configure orcharhino for the first time by using foreman-installer, you can use the --foreman-proxy-dns-managed=false and --foreman-proxy-dhcp-managed=false options to specify that the DNS and DHCP configuration files are not to be managed by Puppet. If you do not use these options during the initial foreman-installer run, rerunning foreman-installer overwrites all manual changes. 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.