Configuring External Services

Configuring orcharhino with external services

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

Configuring orcharhino with external DNS

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

To make any changes persistent, you must enter the orcharhino-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

Copy the /etc/rndc.key file from the external DNS server to orcharhino:
```
$ scp root@dns.example.com:/etc/rndc.key /etc/foreman-proxy/rndc.key
```

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

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

Enter the orcharhino-installer command to make the following persistent changes to the /etc/foreman-proxy/settings.d/dns.yml file:

$ orcharhino-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

In the orcharhino management UI, navigate to Infrastructure > orcharhino Proxies.
Locate the orcharhino and select Refresh from the list in the Actions column.
Associate the DNS service with the appropriate subnets and domain.

Configuring orcharhino with external DHCP

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

configuring an external dhcp server
Configuring Server with an External DHCP Server

Configuring an external DHCP server to use with orcharhino

To configure an external DHCP server running AlmaLinux to use with orcharhino, 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. The example in this procedure uses the distributed Network File System (NFS) protocol to share the DHCP configuration and lease files.

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

On your AlmaLinux host, install the ISC DHCP Service and Berkeley Internet Name Domain (BIND) utilities packages:
```
$ dnf install dhcp-server bind-utils
```
Generate a security token:
```
$ tsig-keygen -a hmac-md5 omapi_key
```

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 Server that you want to use with an external DHCP service.

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.
Configure the firewall for external access to the DHCP server:
```
$ firewall-cmd --add-service dhcp
```
Make the changes persistent:
```
$ firewall-cmd --runtime-to-permanent
```
On orcharhino Server, determine the UID and GID of the foreman user:
```
$ id -u foreman
993
$ id -g foreman
990
```
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
```

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

Enable and start the DHCP service:
```
$ systemctl enable --now dhcpd
```

Export the DHCP configuration and lease files using NFS:

$ dnf install nfs-utils
$ systemctl enable --now nfs-server

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
```

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

Mount the file systems in /etc/fstab:
```
$ mount -a
```

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.

Reload the NFS server:
```
$ exportfs -rva
```
Configure the firewall for DHCP omapi port 7911:
```
$ firewall-cmd --add-port=7911/tcp
```

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

Make the changes persistent:
```
$ firewall-cmd --runtime-to-permanent
```

Configuring orcharhino Server with an external DHCP server

You can configure orcharhino with an external DHCP server.

Prerequisites

Ensure that you have configured an external DHCP server and that you have shared the DHCP configuration and lease files with orcharhino. For more information, see configuring an external dhcp server.

Procedure

Install the nfs-utils package:
```
$ dnf install nfs-utils
```

Create the DHCP directories for NFS:

$ mkdir -p /mnt/nfs/etc/dhcp /mnt/nfs/var/lib/dhcpd

Change the file owner:
```
$ chown -R foreman-proxy /mnt/nfs
```
Verify communication with the NFS server and the Remote Procedure Call (RPC) communication paths:
```
$ showmount -e DHCP_Server_FQDN
$ rpcinfo -p DHCP_Server_FQDN
```

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

Mount the file systems on /etc/fstab:
```
$ mount -a
```
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
```

Enter the orcharhino-installer command to make the following persistent changes to the /etc/foreman-proxy/settings.d/dhcp.yml file:

$ orcharhino-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

Associate the DHCP service with the appropriate subnets and domain.

Configuring orcharhino with external TFTP

You can configure orcharhino with external TFTP services.

Procedure

Create the TFTP directory for NFS:
```
$ mkdir -p /mnt/nfs/var/lib/tftpboot
```

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

Mount the file systems in /etc/fstab:
```
$ mount -a
```
Enter the orcharhino-installer command to make the following persistent changes to the /etc/foreman-proxy/settings.d/tftp.yml file:
```
$ orcharhino-installer \
--foreman-proxy-tftp-root /mnt/nfs/var/lib/tftpboot \
--foreman-proxy-tftp=true
```
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:
```
$ orcharhino-installer --foreman-proxy-tftp-servername=TFTP_Server_FQDN
```
In the orcharhino management UI, navigate to Infrastructure > orcharhino Proxies.
Locate the orcharhino and select Refresh from the list in the Actions column.
Associate the TFTP service with the appropriate subnets and domain.

Configuring orcharhino 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 by using the IdM server.

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

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

configuring dynamic dns update with gss tsig authentication
configuring dynamic dns update with tsig authentication

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

reverting to internal dns service

You are not required to use orcharhino 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 with external IdM DNS and realm enrollment are mutually exclusive.

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

Procedure

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

Creating a Kerberos principal on the IdM server

Obtain a Kerberos ticket for the account obtained from the IdM administrator:
```
$ kinit idm_user
```
Create a new Kerberos principal for orcharhino to use to authenticate on the IdM server:
```
$ ipa service-add orcharhino-proxy.network2.example.com
```

Installing and configuring the idM client

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
```
Configure the IdM client by running the installation script and following the on-screen prompts:
```
$ ipa-client-install
```
Obtain a Kerberos ticket:
```
$ kinit admin
```
Remove any preexisting keytab:
```
$ rm /etc/foreman-proxy/dns.keytab
```

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

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.

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

$ chown foreman-proxy:foreman-proxy /etc/foreman-proxy/dns.keytab

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

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.
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 Server that manages the DNS service for the domain

Configure your orcharhino Server or orcharhino Proxy Server to connect to your DNS service:

$ orcharhino-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

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

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

Procedure

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

Enabling external updates to the DNS zone in the IdM server

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"; };
};
########################################################################

Reload the named service to make the changes take effect:
```
$ systemctl reload named
```
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.
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
```
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
```
Assign the foreman-proxy user to the named group manually. Normally, orcharhino-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
```

On orcharhino Server, enter the following orcharhino-installer command to configure orcharhino to use the external DNS server:

$ orcharhino-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

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==";
};
```
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
```

On orcharhino Server, test the DNS entry:

$ nslookup test.example.com 192.168.25.1

Example output:

Server:		192.168.25.1
Address:	192.168.25.1#53

Name:	test.example.com
Address: 192.168.25.20

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.

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

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.

Reverting to internal DNS service

You can revert to using orcharhino Server and orcharhino Proxy Server 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.

Procedure

On the orcharhino or orcharhino Proxy Server 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 orcharhino-installer command:
```
$ orcharhino-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 orcharhino-installer command on orcharhino or orcharhino Proxy:
```
$ orcharhino-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 orcharhino-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

In the orcharhino management UI, navigate to Infrastructure > orcharhino Proxies.
For each orcharhino Proxy that you want to update, from the Actions list, select Refresh.
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.
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.

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 an external 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:

Install the ipa-client package on orcharhino Server or orcharhino Proxy Server:
```
$ dnf install ipa-client
```
Configure the server as a FreeIPA client:
```
$ ipa-client-install
```
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:

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.network2.example.com:/etc/foreman-proxy/freeipa.keytab
```
On your orcharhino Server, move the /root/freeipa.keytab file to the /etc/foreman-proxy directory:
```
$ mv /root/freeipa.keytab /etc/foreman-proxy
```
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
```
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:
```
$ orcharhino-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.
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
```
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 integrated or external orcharhino Proxy with FreeIPA, you must create a realm and add the FreeIPA-configured orcharhino Proxy to the realm.

Procedure

In the orcharhino management UI, navigate to Infrastructure > Realms and click Create Realm.
In the Name field, enter a name for the realm.
From the Realm Type list, select the type of realm.
From the Realm orcharhino Proxy list, select orcharhino Proxy Server where you have configured FreeIPA.
Click the Locations tab and from the Locations list, select the location where you want to add the new realm.
Click the Organizations tab and from the Organizations list, select the organization where you want to add the new realm.
Click Submit.

Updating host groups with realm information

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

In the orcharhino management UI, navigate to Configure > Host Groups, select the host group that you want to update, and click the Network tab.
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:

On the FreeIPA server, create a host group:

$ ipa hostgroup-add hostgroup_name --desc=hostgroup_description

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

Managing DHCP by using orcharhino Proxy

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

Available DHCP providers

dhcp_infoblox – For more information, see Using Infoblox as DHCP and DNS providers.
dhcp_isc – ISC DHCP server over OMAPI.
dhcp_remote_isc – ISC DHCP server over OMAPI with leases mounted through networking. For more information, see Configuring orcharhino with external DHCP.
dhcp_libvirt – dnsmasq DHCP via libvirt API
dhcp_native_ms – Microsoft Active Directory by using API

Configuring dhcp_libvirt

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

Procedure

You can use orcharhino-installer to configure dhcp_libvirt:

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

Securing the dhcpd API

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

Procedure

On your orcharhino Proxy, install the required packages:
```
$ dnf install bind-utils
```

Generate a key:

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

Use orcharhino-installer to secure the dhcpd API:

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

Managing DNS by using orcharhino Proxy

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

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

Available DNS providers

dns_dnscmd – Static DNS records in Microsoft Active Directory.
dhcp_infoblox – For more information, see Using Infoblox as DHCP and DNS providers.
dns_libvirt – Dnsmasq DNS via libvirt API. For more information, see configuring dns libvirt.
dns_nsupdate – Dynamic DNS update using nsupdate. For more information, see configuring dns nsupdate.
dns_nsupdate_gss – Dynamic DNS update with GSS-TSIG. For more information, see configuring dynamic dns update with gss tsig authentication.
dns_powerdns – PowerDNS. For more information, see configuring dns powerdns.

Configuring dns_nsupdate

The dns_nsupdate DNS provider manages DNS records using the nsupdate utility. You can use dns_nsupdate with any DNS server compatible with RFC2136. By default, dns_nsupdate installs the ISC BIND server. For installation without ISC BIND, see configuring external dns.

Procedure

Configure dns_nsupdate:

$ orcharhino-installer \
--foreman-proxy-dns true \
--foreman-proxy-dns-provider nsupdate \
--foreman-proxy-dns-managed true \
--foreman-proxy-dns-zone example.com \
--foreman-proxy-dns-reverse 2.0.192.in-addr.arpa

Configuring dns_libvirt

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

Procedure

You can use orcharhino-installer to configure dns_libvirt:

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

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

Configuring dns_powerdns

The dns_powerdns DNS provider manages DNS records using the PowerDNS REST API.

Procedure

You can use orcharhino-installer to configure dns_powerdns:

$ orcharhino-installer \
--foreman-proxy-dns true \
--foreman-proxy-dns-provider powerdns \
--enable-foreman-proxy-plugin-dns-powerdns \
--foreman-proxy-plugin-dns-powerdns-rest-api-key api_key \
--foreman-proxy-plugin-dns-powerdns-rest-url http://localhost:8081/api/v1/servers/localhost

Configuring dns_route53

Route 53 is a DNS provider by Amazon. For more information, see aws.amazon.com/route53.

Procedure

Enable Route 53 DNS on your orcharhino Proxy:

$ orcharhino-installer \
--enable-foreman-proxy-plugin-dns-route53 \
--foreman-proxy-dns true \
--foreman-proxy-dns-provider route53 \
--foreman-proxy-plugin-dns-route53-aws-access-key My_AWS_Access_Key \
--foreman-proxy-plugin-dns-route53-aws-secret-key My_AWS_Secret_Key

Using Infoblox as DHCP and DNS providers

You can use orcharhino to connect to your Infoblox application to create and manage DHCP and DNS records, and to reserve IP addresses.

The supported Infoblox version is NIOS 8.0 or higher.

Infoblox limitations

All DHCP and DNS records can be managed only in a single Network or DNS view. After you install the Infoblox modules on orcharhino and set up the view using the orcharhino-installer command, you cannot edit the view.

orcharhino communicates with a single Infoblox node by using the standard HTTPS web API. If you want to configure clustering and High Availability, make the configurations in Infoblox.

Hosting PXE-related files by using the TFTP functionality of Infoblox is not supported. You must use orcharhino as a TFTP server for PXE provisioning. For more information, see Configuring networking in Provisioning Hosts.

orcharhino IPAM feature cannot be integrated with Infoblox.

Infoblox prerequisites

You must have Infoblox account credentials to manage DHCP and DNS entries in orcharhino.
Ensure that you have Infoblox administration roles with the names: DHCP Admin and DNS Admin.
The administration roles must have permissions or belong to an admin group that permits the accounts to perform tasks through the Infoblox API.

Installing the Infoblox CA certificate

You must install Infoblox HTTPS CA certificate on the base system of orcharhino.

Procedure

Download the certificate from the Infoblox web UI or you use the following OpenSSL commands to download the certificate:
```
$ update-ca-trust enable
$ openssl s_client -showcerts -connect infoblox.example.com:443 </dev/null | \
openssl x509 -text >/etc/pki/ca-trust/source/anchors/infoblox.crt
$ update-ca-trust extract
```
The infoblox.example.com entry must match the host name for the Infoblox application in the X509 certificate.

Verification

Test the CA certificate by using a curl query:

$ curl -u admin:password https://infoblox.example.com/wapi/v2.0/network

Example positive response:

[
    {
        "_ref": "network/ZG5zLm5ldHdvcmskMTkyLjE2OC4yMDIuMC8yNC8w:infoblox.example.com/24/default",
        "network": "192.168.202.0/24",
        "network_view": "default"
    }
]

Installing the DHCP Infoblox module

Install the DHCP Infoblox module on orcharhino. Note that you cannot manage records in separate views.

You can also install DHCP and DNS Infoblox modules simultaneously by combining this procedure and Installing the DNS Infoblox Module.

DHCP Infoblox record type considerations

If you want to use the DHCP and DNS Infoblox modules together, configure the DHCP Infoblox module with the fixedaddress record type only. The host record type causes DNS conflicts and is not supported.

If you configure the DHCP Infoblox module with the host record type, you have to unset both DNS orcharhino Proxy and Reverse DNS orcharhino Proxy options on your Infoblox-managed subnets, because Infoblox does DNS management by itself. Using the host record type leads to creating conflicts and being unable to rename hosts in orcharhino.

Procedure

On orcharhino, enter the following command:

$ orcharhino-installer --enable-foreman-proxy-plugin-dhcp-infoblox \
--foreman-proxy-dhcp true \
--foreman-proxy-dhcp-provider infoblox \
--foreman-proxy-dhcp-server infoblox.example.com \
--foreman-proxy-plugin-dhcp-infoblox-username admin \
--foreman-proxy-plugin-dhcp-infoblox-password infoblox \
--foreman-proxy-plugin-dhcp-infoblox-record-type fixedaddress \
--foreman-proxy-plugin-dhcp-infoblox-dns-view default \
--foreman-proxy-plugin-dhcp-infoblox-network-view default

Optional: In the orcharhino management UI, navigate to Infrastructure > orcharhino Proxies, select the orcharhino Proxy with the DHCP Infoblox module, and ensure that the dhcp feature is listed.
In the orcharhino management UI, navigate to Infrastructure > Subnets.
For all subnets managed through Infoblox, ensure that the IP address management (IPAM) method of the subnet is set to DHCP.

Installing the DNS Infoblox module

Install the DNS Infoblox module on orcharhino. You can also install DHCP and DNS Infoblox modules simultaneously by combining this procedure and Installing the DHCP Infoblox Module.

Procedure

On orcharhino, enter the following command to configure the Infoblox module:

$ orcharhino-installer --enable-foreman-proxy-plugin-dns-infoblox \
--foreman-proxy-dns true \
--foreman-proxy-dns-provider infoblox \
--foreman-proxy-plugin-dns-infoblox-dns-server infoblox.example.com \
--foreman-proxy-plugin-dns-infoblox-username admin \
--foreman-proxy-plugin-dns-infoblox-password infoblox \
--foreman-proxy-plugin-dns-infoblox-dns-view default

Optionally, you can change the value of the --foreman-proxy-plugin-dns-infoblox-dns-view option to specify an Infoblox DNS view other than the default view.

Optional: In the orcharhino management UI, navigate to Infrastructure > orcharhino Proxies, select the orcharhino Proxy with the Infoblox DNS module, and ensure that the dns feature is listed.
In the orcharhino management UI, navigate to Infrastructure > Domains.
For all domains managed through Infoblox, ensure that the DNS Proxy is set for those domains.
In the orcharhino management UI, navigate to Infrastructure > Subnets.
For all subnets managed through Infoblox, ensure that the DNS orcharhino Proxy and Reverse DNS orcharhino Proxy are set for those subnets.

Appendix A: dhcp_isc settings

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

Configuring the path to the config and leases files:

:config: /etc/dhcp/dhcpd.conf
:leases: /var/lib/dhcpd/dhcpd.leases

Securing the DHCP server with an omapi_key

:key_name: My_OMAPI_Key
:key_secret: My_Key_Secret

Setting a port on which the DHCP server listens

:omapi_port: My_DHCP_Server_Port  # default: 7911

The server is defined in dhcp.yml:

Setting the host on which the DHCP server runs on

:server: My_DHCP_Server_FQDN

Appendix B: DHCP options for network configuration

--foreman-proxy-dhcp: Enables the DHCP service. You can set this option to true or false.
--foreman-proxy-dhcp-managed: Enables Foreman to manage the DHCP service. You can set this option to true or false.
--foreman-proxy-dhcp-gateway: The DHCP pool gateway. Set this to the address of the external gateway for hosts on your private network.
--foreman-proxy-dhcp-interface: Sets the interface for the DHCP service to listen for requests. Set this to eth1.
--foreman-proxy-dhcp-nameservers: Sets the addresses of the nameservers provided to clients through DHCP. Set this to the address for orcharhino Server on eth1.
--foreman-proxy-dhcp-range: A space-separated DHCP pool range for Discovered and Unmanaged services.
--foreman-proxy-dhcp-server: Sets the address of the DHCP server to manage.
--foreman-proxy-dhcp-subnets: Sets the subnets of the DHCP server to manage. Example: --foreman-proxy-dhcp-subnets 192.168.205.0/255.255.255.128 or --foreman-proxy-dhcp-subnets 192.168.205.128/255.255.255.128

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

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