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
  1. 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
  2. Configure the ownership, permissions, and SELinux context:

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

    # echo -e "server DNS_IP_Address\n \
    update add aaa.example.com 3600 IN A Host_IP_Address\n \
    send\n" | nsupdate -k /etc/foreman-proxy/rndc.key
    # nslookup aaa.example.com DNS_IP_Address
    # echo -e "server DNS_IP_Address\n \
    update delete aaa.example.com 3600 IN A Host_IP_Address\n \
    send\n" | nsupdate -k /etc/foreman-proxy/rndc.key
  4. Enter the 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
  5. In the orcharhino management UI, navigate to Infrastructure > orcharhino Proxies.

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

  7. 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 to use with orcharhino

To configure an external DHCP server running Enterprise Linux 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
  1. On your Enterprise Linux host, install the ISC DHCP Service and Berkeley Internet Name Domain (BIND) utilities packages:

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

    # dnssec-keygen -a HMAC-MD5 -b 512 -n HOST omapi_key

    As a result, a key pair that consists of two files is created in the current directory.

  3. Copy the secret hash from the key:

    # grep ^Key Komapi_key.+*.private | cut -d ' ' -f2
  4. Edit the dhcpd configuration file for all subnets and add the key. The following is an example:

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

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

  5. Delete the two key files from the directory that they were created in.

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

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

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

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

    # id -u foreman
    993
    # id -g foreman
    990
  10. 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
  11. 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
  12. Enable and start the DHCP service:

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

    # dnf install nfs-utils
    # systemctl enable --now nfs-server
  14. 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
  15. 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
  16. Mount the file systems in /etc/fstab:

    # mount -a
  17. 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.

  18. Reload the NFS server:

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

    # firewall-cmd --add-port=7911/tcp
  20. 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
  21. 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
  1. Install the nfs-utils package:

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

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

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

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

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

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

    # su foreman-proxy -s /bin/bash
    $ cat /mnt/nfs/etc/dhcp/dhcpd.conf
    $ cat /mnt/nfs/var/lib/dhcpd/dhcpd.leases
    $ exit
  8. Enter the 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
  9. Associate the DHCP service with the appropriate subnets and domain.

Configuring orcharhino with external TFTP

You can configure orcharhino with external TFTP services.

Procedure
  1. Create the TFTP directory for NFS:

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

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

    # mount -a
  4. Enter the 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
  5. If the TFTP service is running on a different server than the DHCP service, update the tftp_servername setting with the FQDN or IP address of the server that the TFTP service is running on:

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

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

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

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

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. For more information about configuring realm enrollment, see

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. For more information, see Configuring orcharhino Server.

Procedure

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

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

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

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

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

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

    # kinit admin
  4. Remove any preexisting keytab:

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

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

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

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

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

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

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

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

    3. Click Add and Edit.

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

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

    6. Enable Allow PTR sync.

    7. Click Save to save the changes.

  2. Create and configure the reverse zone:

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

    2. Click Add.

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

    4. Click Add and Edit.

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

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

    7. Click Save to save the changes.

Configuring the orcharhino or orcharhino Proxy that manages the DNS service for the domain
  1. Use the orcharhino-installer command to configure the orcharhino or orcharhino Proxy that manages the DNS Service for the domain:

    • On orcharhino, enter the following command:

      # 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
    • On orcharhino Proxy, enter the following command:

      # 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

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
  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 is configured to provide DNS service for your deployment.

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

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

Procedure

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

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

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

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

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

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

    3. Click Update to save the changes.

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

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

    # restorecon -v /etc/rndc.key
    # chown -v root:named /etc/rndc.key
    # chmod -v 640 /etc/rndc.key
  6. Assign the foreman-proxy user to the named group manually. Normally, 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
  7. 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
  1. Ensure that the key in the /etc/rndc.key file on orcharhino Server is the same key file that is used on the IdM server:

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

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

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

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

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

    # nslookup test.example.com 192.168.25.1

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

Reverting to internal DNS service

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

Procedure

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

Configuring orcharhino or orcharhino Proxy as a DNS server
  • If you have created a backup of the answer file before configuring external DNS, restore the answer file and then enter the 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
  1. In the orcharhino management UI, navigate to Infrastructure > orcharhino Proxies.

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

  3. Configure the domain:

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

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

  4. Configure the subnet:

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

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

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

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

    5. Click Submit to save the changes.

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