Documentation on valid options for nebari-config.yaml?

[mwengren]

I haven't been able to find any documentation that defines allowed/expected values in nebari-config.yaml for specific parameters that are mentioned in the Nebari Docs.

Here's an example: the Setup Nebari Domain Registry docs mention four different options available. There's an example for CloudFlare with a snippit from an example config file, which is great, but there's nothing similar for the other providers listed (e.g. Google Cloud DNS, Azure DNS, AWS Route53).

Obviously, CloudFlare is the preferred option based on the docs, but what if I want to use Route53 (which in my case I must)?

I've looked through the code and so far haven't been able to find an answer there (might have missed something admittedly).

Please point me in the right direction if missed a page already in the docs, but it would seem adding allowed values to the existing docs pages that mention a specific config parameter would be helpful, if not in a separate page that has an exhaustive list of params/allowed values.

[viniciusdc]

Hey @mwengren, thanks for bringing that up. I suppose there is a misunderstanding in the way the documentation is written. I will need to check. However, the essence is that Nebari dynamically provisions the DNS entries only on CloudFlare. At the same time, any other provider requires manual setup. The method for doing so varies significantly across each provider. Nebari is a project with a few years on its back. When we first introduced the DNS provision, a few providers still didn't have the option to set up DNS themselves (I believe that back then, only Azure and AWS supported it). Then we decided to use an external one, and at the time, CloudFlare was chosen since we had more experience with them.

During the Nebari deployment, when the Traefik LB is defined, we temporarily expose the external IP to be used in your DNS configuration; that's the most we could do back then. We don't have that in our roadmap for expanding to more providers, though a PR would always be welcomed.

[viniciusdc]

In the case of Route53, it seems that the doc you are looking for is this one https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/domain-register.html#domain-register-procedure-section. Then, with your domain setup, update the domain field under your nebari-config.yaml to point to your newly registered domain.

Sometimes, the DNS provider also provides a set of certificates for your domain. In such cases, you will need to follow these instructions https://www.nebari.dev/docs/explanations/advanced-configuration#certificates under the Custom Self-signed certs tab.