search

bcgov / aps-infra-platform

Documentation for the API Management Platform
https://bcgov.github.io/aps-infra-platform/
Apache License 2.0
1 stars 3 forks source link

APS-3138 - Add to custom domain + gw config formats #91

Open rustyjux opened 4 days ago

rustyjux commented 4 days ago

Q: For custom custom domains, will we handle DNS for clients in any cases? In all cases? Normally, we take care of DNS for Gold and we intend to do so for Emerald. What if users have a custom domain on these clusters? What about custom domains on Silver cluster?

In the current version of the docs, I have assumed that we will take care of DNS regardless of cluster at the same time we add the perm-domains permission. We should add to client onboarding docs to show a DNS entry for a custom domain on the Silver data plane.

ikethecoder commented 4 days ago

For custom custom domains, will we handle DNS for clients in any cases?

For custom domains, we never handle DNS.. due to the fact that we don't own the domain.

rustyjux commented 4 days ago

Riiight. We'll need to add a section before Validation which includes instructions on configuring DNS.

I feel like the content on the Set Up an Upstream page isn't directed enough to this context and so some duplication here makes sense.

I had previously drafted:

## Configure DNS for your custom domain

You will need to add a DNS record for your custom domain pointing to the OpenShift cluster where your Gateway is deployed.

### Silver cluster

By default, new Gateways are created on the Silver cluster. Create an A record
for your custom domain pointing to `142.34.194.118` - Silver's ingress IP
address.

### Gold cluster

Gold cluster route hosts will resolve to `142.34.229.4` or `142.34.64.4` depending on whether the APS service is in Gold (Kamloops) or for disaster recovery in Gold DR (Calgary).

Create a CNAME record for your custom domain pointing to `ggw.api.gov.bc.ca.glb.gov.bc.ca`, APS's Global Load Balancer which handles routing to the appropriate cluster.

### Emerald cluster

need to complete with info on getting IP address from us for Emerald.

Can finish next week or if someone wants to follow through before then, that's swell.