Node DNS

When DNS Management is configured, the Atlas Experience Manager can automatically manage DNS entries for the Nodes. This guide walks through the necessary configuration for Node DNS.

Table of Contents

• Table of Contents
• Prerequisites
• Related Features
• Considerations
• Configuration
• Available DNS Backends
  • Cloudflare
  • DNSimple

Prerequisites

To Use Node DSN, the follow prerequisites are required:

1. Supported DNS Provider (currently Cloudflare or DNSimple)
2. A domain name with a supported DNS provider to assign Nodes to
3. REST API Credentials for DNS Provider (see details under backends below)

Related Features

The following features are related to Node DNS:

• Node TLS - When Node DNS is in-use, Node TLS may be configured to automatically issue TLS certificates for Nodes.

Considerations

While Node DNS may be used directly within local networks, it’s intended use, and power is when combined with the Atlas Experience Fabric and automated TLS provisioning for Nodes.

Before deploying Node DNS, see Experience Fabric to better understand the capabilities and why you may want to enable Node DNS.

Configuration

TIP

Additional Environment Variables will be required depending on the selected DNS backend.

Environment Variable	Description	Default
USE_NODE_DNS	Enable automatic Node DNS entries (True or False)	False
NODE_DNS_BACKEND	The DNS provider backend to use (see below)	None
NODE_DNS_DOMAIN	The domain (i.e. example.com) to assign Nodes to.	None
NODE_DNS_SUBDOMAIN	(optional) Subdomain to assign the Node to. By default, Nodes are assigned to the NODE_DNS_DOMAIN (example: <alias>.example.com). When NODE_DNS_SUBDOMAIN is set to a value such as client, the domain becomes: <alias>.client.example.com.	None
NODE_DNS_IP_SELECTOR	Select fabric for the Experience Fabric IP or internal for local network IP	fabric

Available DNS Backends

The follow DNS providers are available for automatic Node DNS assignment:

Provider	Value
Cloudflare	xot.common.dns.cloudflare.CloudflareDnsBackend
DNSimple	xot.common.dns.cloudflare.DNSimpleDnsBackend

Cloudflare

To create a CLOUDFLARE_API_TOKEN, login to your Cloudflare accound. From your account landing page, select Manage Account / Account API Tokens. Create a token with DNS:Edit for the domain(s) available to the Experience Manager to manage DNS records for.

Environment Variable	Description	Default
CLOUDFLARE_API_TOKEN	The Cloudflare API Token, with DNS:Edit permissions.	None

DNSimple

To create obtain DNSimple credentials, login to your DNSimple account and follow the instructions for each variable below:

Environment Variable	Description	Default
DNSIMPLE_ACCOUNT_ID	From your account page, select Account Settings / Access Tokens, your account ID will be displayed on this page.	False
DNSIMPLE_ACCESS_TOKEN	From your account page, select Account Settings / Access Tokens	None