Chapter 3. Installing and configuring the DNS service

You install and configure the DNS service (designate) by including the designate environment file when you deploy or redeploy the Red Hat OpenStack Platform (RHOSP). The toolset for deploying RHOSP, director, uses Orchestration service (heat) environment templates and environment files as a set of plans for how to install and configure the DNS service and the rest of your RHOSP deployment.

When deploying the DNS service, director automatically performs such actions as enabling the DNS service for active-active High Availability mode and activating automation for port and floating IP addresses. Director also configures the Networking service (neutron) to point to the Unbound resolvers included with DNS service.

Note

You can explicitly disable the configuration of the Unbound resolvers by setting UnboundForwardResolvers in a custom heat environment file.

You can also integrate the DNS service with a pre-existing DNS infrastructure by providing director with the necessary DNS server information.

Important

In RHOSP 17.0, integrating the DNS service with a pre-existing DNS infrastructure is a technology preview feature.

The topics included in this section are:

3.1. Deploying the DNS service

You use Red Hat OpenStack Platform (RHOSP) director to deploy the DNS service (designate). Director uses Orchestration service (heat) templates and environment files that are a set of plans for your RHOSP deployment. The undercloud imports these plans and follows their instructions to install and configure the DNS service and your RHOSP deployment.

Prerequisites

  • You must be the stack user with access to the RHOSP undercloud.

Procedure

  1. If you are integrating the DNS server with a pre-existing DNS infrastructure, go to the topic, Section 3.2, “Deploying the DNS service with pre-existing BIND 9 servers”.
  2. Log in to the undercloud host as the stack user.

  3. Source the undercloud credentials file: 

    $ source ~/stackrc

  4. Run the deployment command and include the core heat templates, other environment files, and the enable-designate.yaml environment file.

    Example

    $ openstack overcloud deploy --templates \
-e <other_environment_files> \
-e /usr/share/openstack-tripleo-heat-templates/environments/\
enable-designate.yaml

    Note

    Director updates the various DNS service components to the latest designate image during a stack update or upgrade.

Verification

  • Confirm that the DNS service has been installed and has an endpoint defined. 

    $ openstack endpoint list -c "Service Name" -c Enabled -c URL

    Sample output

    +--------------+---------+-------------------------------------------------+
| Service Name | Enabled | URL                                             |
+--------------+---------+-------------------------------------------------+
| swift        | True    | http://198.51.100.61:8080                       |
| designate    | True    | http://203.0.113.103:9001                       |
| heat-cfn     | True    | http://192.0.2.137:8000/v1                      |
| designate    | True    | http://192.0.2.137:9001                         |
| placement    | True    | http://203.0.113.103:8778/placement             |
| cinderv3     | True    | http://203.0.113.103:8776/v3/%(tenant_id)s      |
| heat         | True    | http://203.0.113.103:8004/v1/%(tenant_id)s      |
| heat-cfn     | True    | http://203.0.113.103:8000/v1                    |
| nova         | True    | http://203.0.113.103:8774/v2.1                  |
| heat         | True    | http://192.0.2.137:8004/v1/%(tenant_id)s        |
| glance       | True    | http://203.0.113.103:9292                       |
| heat         | True    | http://203.0.113.103:8004/v1/%(tenant_id)s      |
| glance       | True    | http://203.0.113.103:9292                       |
| neutron      | True    | http://203.0.113.103:9696                       |
| nova         | True    | http://192.0.2.137:8774/v2.1                    |
| cinderv3     | True    | http://192.0.2.137:8776/v3/%(tenant_id)s        |
| placement    | True    | http://203.0.113.103:8778/placement             |
| keystone     | True    | http://192.168.24.17:35357                      |
| neutron      | True    | http://192.0.2.137:9696                         |
| nova         | True    | http://203.0.113.103:8774/v2.1                  |
| heat-cfn     | True    | http://203.0.113.103:8000/v1                    |
| cinderv3     | True    | http://203.0.113.103:8776/v3/%(tenant_id)s      |
| glance       | True    | http://192.0.2.137:9292                         |
| placement    | True    | http://192.0.2.137:8778/placement               |
| swift        | True    | http://198.51.100.61:8080/v1/AUTH_%(tenant_id)s |
| swift        | True    | http://192.0.2.137:8080/v1/AUTH_%(tenant_id)s   |
| designate    | True    | http://203.0.113.103:9001                       |
| keystone     | True    | http://192.0.2.137:5000                         |
| neutron      | True    | http://203.0.113.103:9696                       |
| keystone     | True    | http://203.0.113.103:5000                       |
+--------------+---------+-------------------------------------------------+

Additional resources

3.2. Deploying the DNS service with pre-existing BIND 9 servers

You use Red Hat OpenStack Platform (RHOSP) director to install and configure the DNS service (designate) and integrate it with a pre-existing BIND 9 DNS infrastructure. Director uses Orchestration service (heat) templates and environment files that are a set of plans for your RHOSP deployment. You add the specific information about your DNS servers to a heat environment file. The undercloud imports these plans and follows their instructions to install and configure RHOSP and the DNS service and integrate it with your DNS infrastructure.

Important

This feature is available in this release as a Technology Preview, and therefore is not fully supported by Red Hat. It should only be used for testing, and should not be deployed in a production environment. For more information about Technology Preview features, see Scope of Coverage Details.

Prerequisites

  • You have a pre-existing DNS infrastructure that relies on BIND 9 servers.
  • Ensure that your BIND 9 servers meet the configuration that is described in Configuring existing BIND servers for the DNS service.
  • You must be the stack user with access to the RHOSP undercloud.

Procedure

  1. If you are not integrating the DNS server with a pre-existing DNS infrastructure, go to the topic, Section 3.1, “Deploying the DNS service”.
  2. Log in to the undercloud host as the stack user.

  3. Source the undercloud credentials file: 

    $ source ~/stackrc

  4. Create a custom YAML environment file.

    Example

    $ vi /home/stack/templates/my-designate-environment.yaml

  5. Your environment file must contain the keywords parameter_defaults and DesignateExternalBindServers. Add the IP address and the Remote Name Daemon Control (RNDC) key for each of your BIND 9 DNS servers on new lines beneath DesignateExternalBindServers.

    Example

    In this example, there are two pre-existing BIND 9 servers, 203.0.113.3 and 203.0.113.4, with an RNDC key, respectively: 

    parameter_defaults:
  DesignateExternalBindServers:
    - host: 203.0.113.3
      rndc_key: "FJOdVqZr5gVXbU9kIagY0IJVDq7CV/mDVb/M7mlLMgY="
    - host; 203.0.113.4
      rndc_key: "QAAACCdIV3KXPJh6U71ImVH0+j4uKRpVV49zVU7A8uvm"

  6. Run the deployment command and include the core heat templates, other environment files, the enable-designate.yaml environment file, and this new custom environment file.

    Important

    The order of the environment files is important as the parameters and resources defined in subsequent environment files take precedence.

    Example

    $ openstack overcloud deploy --templates \
-e <other_environment_files> \
-e /usr/share/openstack-tripleo-heat-templates/environments/\
enable-designate.yaml

    Note

    Director updates the various DNS service components to the latest designate image during a stack update or upgrade.

Additional resources

3.3. Changing DNS service default settings

You make configuration changes to the Red Hat OpenStack Platform (RHOSP) DNS service (designate) by modifying a YAML-formatted environment file and redeploying your RHOSP overcloud. The RHOSP director is a toolset that uses Orchestration service (heat) templates and environment files as a plan to configure the DNS service.

Prerequisites

  • You must be the stack user with access to the RHOSP undercloud.

  • Decide which RHOSP DNS service parameters that you want to modify.

    Here are a few examples:

    • DesignateRpcResponseTimeout

      The RPC response timeout, in seconds, for the DNS service. The default is 60 seconds.

    • DesignateWorkers

      The number of workers for Designate services. The default is zero (0), which means that the deployment script uses the RHOSP director value for operating system workers.

      For more information, see Determining environment scale in the Director Installation and Usage guide.

    • DesignateMdnsProxyBasePort

      The base port for the MiniDNS proxy endpoints on the external or public access network. The default port is 16000.

Procedure

  1. Log in to the undercloud host as the stack user.

  2. Source the undercloud credentials file: 

    $ source ~/stackrc

  3. Create a custom YAML environment file.

    Example

    $ vi /home/stack/templates/my-designate-environment.yaml

    Your environment file must contain the keywords parameter_defaults. Put your parameter value pairs after the parameter_defaults keyword.

    Example

    In this example, the RPC response timeout is set to 120 seconds: 

    parameter_defaults:
  DesignateRpcResponseTimeout: '120'

  4. Run the deployment command and include the core heat templates, other environment files, the enable-designate.yaml environment file, and this new custom environment file.

    Important

    The order of the environment files is important as the parameters and resources defined in subsequent environment files take precedence.

    Example

    $ openstack overcloud deploy --templates \
-e <other_environment_files> \
-e /usr/share/openstack-tripleo-heat-templates/environments/\
enable-designate.yaml \
-e /home/stack/templates/my-designate-environment.yaml

Additional resources