NREL / api-umbrella

Open source API management platform
MIT License
2.01k stars 325 forks source link

How to configure API Umbrella for CNAME domain? #213

Open brylie opened 8 years ago

brylie commented 8 years ago

At a conference, we were asked whether API Umbrella (and Apinf) can be configured to use a CNAME domain. On the spot, I intuitively answered 'yes', but am unsure if the implications in retrospect.

What are some considerations when configuring a CNAME domain for an existing API Umbrella instance?

GUI commented 8 years ago

Yes, multi-tenancy across multiple domains is one of the primary things we aim to support. As an example, api.data.gov serves both https://api.nasa.gov and https://developer.nrel.gov (among others) from a single API Umbrella cluster. I'll try to get some better documentation written on this subject, but there's typically not much to it other than pointing a CNAME to your servers. API Umbrella will then route based on that hostname, so you can setup API Backends using that hostname, or API Scopes to limit admin permissions, and everything should work as expected.

The only real trick to getting this setup is SSL, where there are several options. A couple primary ones we've used:

jykae commented 8 years ago

Great to hear, this is important for branding purposes. :+1:

kyyberi commented 8 years ago

+1

bajiat commented 7 years ago

@GUI Any updates on this issue?

GUI commented 7 years ago

@bajiat: We do support multiple domains and CNAMES (routing can be configured through the "Frontend Host" on API backends, and admin permissions can be setup for multi-tenancy). So I guess I'm not entirely certain what your question is. Were you wondering about built-in support for SSL on CNAMES? Or just better docs around this? Or something else?