Setup Nebari domain registry

Phase out notice

Nebari is evolving. The original Nebari project is now called Nebari Classic, and is in maintenance mode.

We'll continue to provide security updates and key bug fixes; however, no new features are planned at this time. We're using the lessons learned from Nebari Classic to build a new Nebari ecosystem of tools, on a more robust foundation with a modular architecture. Nebari Classic's maintenance window will remain open until the new architecture reaches stability and feature parity, and current users are able to migrate, expected through the end of 2026.

See the current Nebari documentation for details on the new platform.

What is a DNS?

The Domain Name System (DNS) turns domain names into IP addresses, which browsers use to load internet pages. Every device connected to the internet has its IP address, which other devices use to locate the device. DNS name servers are used to locate the IP address of a domain name using words or instead of direct IP addresses.

Setting up a DNS

During deployment, Nebari will generate an Ingress IP for connection with the Kubernetes cluster and all related services that Nebari runs. If not automatically handled, Nebari will request the user to generate the necessary DNS records and update the domain within the newly created IP:

Take IP Address 12.312.312.312 and update DNS to point to "your.domain" [Press Enter when Complete]

Once the IP is generated, you will need to grab it and create the necessary records within the DNS provider of your choice. Setting a DNS record heavily depends on your provider, so an internet search for A/CNAME record for your specific provider should yield helpful results.

Note

During the initial deployment, GCP and Azure will display an "IP" address, that you can use to set the A record. Whereas, AWS will display a "hostname" that you can use to set the CNAME record.

Cloudflare

Nebari supports Cloudflare as a DNS provider out of the box. If you choose to use Cloudflare, first create an account, then there are two possible following options:

1. You can register your application domain name on it, using the Cloudflare nameserver (recommended).

2. You can purchase a new domain with Cloudflare.

To generate a token follow the steps below. For additional information, see the CloudFlare docs.

Setting up an API token on CloudFlare

• Under Profile, select the API Tokens menu and click on Create API Token.

• On Edit zone DNS click on Use Template..

• Configure Permissions such as the image below:

• On Account Resources set the configuration to include your desired account.

• On Zone Resources set it to Include | Specific zone and your domain name.

• Click continue to summary.

• Click on the Create Token button and set the token generated as an environment variable on your machine.

Setup API token locally

Finally, set the token value as an environment variable:

 export CLOUDFLARE_TOKEN="cloudflaretokenvalue"

Also, add a dns section to the nebari-config.yaml file.

dns:
  provider: cloudflare

Using other DNS providers

Currently, Nebari only supports CloudFlare for [automatic DNS registration](link to automatic section below). If an alternate DNS provider is desired, change the dns.provider field from cloudflare to none in the nebari-config.yaml file.

Below are the links to detailed documentation on how to create and manage DNS records on a few providers:

• Cloud DNS provider
• Amazon Route 53 DNS provider
• Azure DNS provider

Note

Once your new DNS domain is created, it might take time for the records and related certificates to fully propagate. The amount of time this takes varies for each DNS provider. Validate such information in the related documentation for your chosen provider.

Automatic DNS provision

Nebari also supports management and the creation of the DNS records for you automatically. For automatic DNS provision add dns.auto_provision to your Nebari config file:

dns:
  provider: cloudflare
  auto_provision: true

This will set the DNS provider as Cloudflare and automatically handle the creation or updates to the Nebari domain DNS records on Cloudflare.

Caution

The usage of dns.auto_provision is restricted to Cloudflare as it is the only fully integrated DNS provider that Nebari currently supports.

Caution

Earlier version of Nebari supports dns settings through --dns-provider and --dns-auto-provision flags in the deploy command. But this feature is removed in favor of using the nebari-config.yaml file.

When you are done setting up the domain name, you can refer back to the Nebari deployment documentation and continue the remaining steps.