Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions alb/request-handling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Datum's Application Load Balancer (ALB) runs on Datum's edge, the proxies that s

| Question | Short answer |
|---|---|
| Where is the client's IP address? | The last entry of `X-Forwarded-For`, and `X-Envoy-External-Address`. See [Find the client's IP address](#find-the-clients-ip-address). |
| Where is the client's IP address? | The last entry of `X-Forwarded-For`, and `X-Envoy-External-Address`. See [Find the client's IP address](#find-the-client’s-ip-address). |
| How long can a response stay open? | About 15 seconds by default, streaming included. You can raise it to 1 hour. See [How long a response can stay open](#how-long-a-response-can-stay-open). |
| Is plain HTTP redirected to HTTPS? | Only when Force HTTPS or a redirect rule is on. See [Plain HTTP](#plain-http). |

Expand Down Expand Up @@ -39,7 +39,7 @@ Origin sees: X-Forwarded-For: 198.51.100.23,203.0.113.7

| Header | What the origin sees |
|---|---|
| `X-Forwarded-For` | The client's IP address, appended. See [Find the client's IP address](#find-the-clients-ip-address). |
| `X-Forwarded-For` | The client's IP address, appended. See [Find the client's IP address](#find-the-client’s-ip-address). |
| `X-Envoy-External-Address` | The client's IP address. Replaces any value the client sent. |
| `X-Forwarded-Proto` | `https` or `http`: the protocol the client used to reach the edge. Replaces any value the client sent. Measured on `networkService` backends. |
| `X-Request-Id` | A unique ID that the edge generates for each request. |
Expand Down
2 changes: 1 addition & 1 deletion domain-dns/private-dns-zones.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@

`db.datum.internal` now resolves on that network only. You can't add records at or below `instances.datum.internal`, which Compute owns.

You can also use the `datumctl dns` plugin, which needs DNS enabled in the project. See [Troubleshooting](/domain-dns/troubleshooting#dns-isnt-enabled-for-my-project). Every network has its own `datum.internal` zone. If your project has more than one network, add `--vpc` with the network's name to say which zone you mean:
You can also use the `datumctl dns` plugin, which needs DNS enabled in the project. See [Troubleshooting](/domain-dns/troubleshooting#dns-isn’t-enabled-for-my-project). Every network has its own `datum.internal` zone. If your project has more than one network, add `--vpc` with the network's name to say which zone you mean:

```bash
datumctl dns record create datum.internal db AAAA fd20:1::20 --vpc default
Expand Down Expand Up @@ -106,7 +106,7 @@

An association can't be edited to point at a different zone or network. Delete it and create a new one. If you delete and recreate a zone with the same name, also recreate its associations.

A network can't have two associated zones with the same domain. A zone can sit below another associated zone, such as `db.corp.internal` below `corp.internal`. Lookups use the zone with the longest matching domain.

Check warning on line 109 in domain-dns/private-dns-zones.mdx

View check run for this annotation

Mintlify / Mintlify Validation (datum-4926dda5) - vale-spellcheck

domain-dns/private-dns-zones.mdx#L109

Did you really mean 'Lookups'?

## Add records to a private zone

Expand Down
2 changes: 1 addition & 1 deletion guides/alb-as-httpd.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Use ALB as your HTTP proxy"
sidebarTitle: "ALB as httpd"

Check warning on line 3 in guides/alb-as-httpd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (datum-4926dda5) - vale-spellcheck

guides/alb-as-httpd.mdx#L3

Did you really mean 'httpd'?
description: "Replace the NGINX, Apache, Caddy, or Traefik container in front of your app with Datum's Application Load Balancer."

Check warning on line 4 in guides/alb-as-httpd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (datum-4926dda5) - vale-spellcheck

guides/alb-as-httpd.mdx#L4

Did you really mean 'Caddy'?

Check warning on line 4 in guides/alb-as-httpd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (datum-4926dda5) - vale-spellcheck

guides/alb-as-httpd.mdx#L4

Did you really mean 'Traefik'?
---

{/* Keep this page human readable and high level: a few chosen examples, then link to the
Expand Down Expand Up @@ -288,7 +288,7 @@
<CodeGroup>
```nginx nginx.conf
upstream web { server web:8080; }
upstream api { server api:8080; }

Check warning on line 291 in guides/alb-as-httpd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (datum-4926dda5) - vale-spellcheck

guides/alb-as-httpd.mdx#L291

Did you really mean 'api'?

server {
location / {
Expand Down Expand Up @@ -486,7 +486,7 @@
- **Uploads**: the WAF rejects large request bodies, even in Observe mode. See [WAF](https://github.com/datum-labs/shorts/blob/main/gists/alb/alb-as-httpd-reference.md#waf) in the reference and [WAF configuration](/alb/configuration/waf).
- **WebSockets**: supported to Compute workloads, and not ended by the response timeout. See [WebSockets](/alb/request-handling#websockets).
- **Rate limits**: counted per edge node, not across the whole ALB. See [Rate limits](https://github.com/datum-labs/shorts/blob/main/gists/alb/alb-as-httpd-reference.md#rate-limits).
- **Client IP**: your app reads it from forwarded headers. See [Find the client's IP address](/alb/request-handling#find-the-clients-ip-address).
- **Client IP**: your app reads it from forwarded headers. See [Find the client's IP address](/alb/request-handling#find-the-client’s-ip-address).

### Response timeout

Expand Down Expand Up @@ -538,12 +538,12 @@
Datum issues and renews a certificate for each hostname on the ALB. These leave with the proxy container:

- Certificate files
- certbot

Check warning on line 541 in guides/alb-as-httpd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (datum-4926dda5) - vale-spellcheck

guides/alb-as-httpd.mdx#L541

Did you really mean 'certbot'?
- ACME settings

To check certificate status, run `datumctl alb describe web` and read the `Certificates` line. For more information, see [Serve traffic on your own domain](/alb/operations/custom-domains) and [Serve a wildcard hostname](/alb/configuration/wildcard-hostnames).

### Health checks and failover

Check warning on line 546 in guides/alb-as-httpd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (datum-4926dda5) - vale-spellcheck

guides/alb-as-httpd.mdx#L546

Did you really mean 'failover'?

The ALB has no active health checks. Its passive health checks watch real responses instead: once you turn them on, an Instance that returns a run of 5xx errors is taken out of rotation, separately on each edge node. For settings, see [Passive health checks](/alb/configuration/load-balancing#passive-health-checks). For how Instances are replaced during an update, see [How rollouts work](/compute/placement-and-scaling#how-rollouts-work). For test results, see [Load balancing and rollouts](https://github.com/datum-labs/shorts/blob/main/gists/alb/alb-as-httpd-reference.md#load-balancing-and-rollouts) in the reference.

Expand Down Expand Up @@ -600,7 +600,7 @@

### Access metrics

For the metrics Datum publishes for each ALB, see [Metrics](/alb/observability#metrics). To send them to Grafana Cloud or another Prometheus remote-write endpoint, see [Metrics export](/operations/metrics-export).

Check warning on line 603 in guides/alb-as-httpd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (datum-4926dda5) - vale-spellcheck

guides/alb-as-httpd.mdx#L603

Did you really mean 'Grafana'?

{/* STUB. Where to see request rate, error rate, and latency for the ALB. State how to reach them (datumctl and the portal), the retention window, and which metrics to alert on first. Link to telemetry metrics docs. */}

Expand Down Expand Up @@ -674,7 +674,7 @@

### Rollback plan

Keep the old proxy container deployable until the ALB has carried production traffic for a while. Lower your DNS TTL before cutover so you can point back quickly. See [Cut over](https://github.com/datum-labs/shorts/blob/main/gists/alb/alb-as-httpd-reference.md#cut-over) in the reference.

Check warning on line 677 in guides/alb-as-httpd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (datum-4926dda5) - vale-spellcheck

guides/alb-as-httpd.mdx#L677

Did you really mean 'cutover'?

{/* STUB. Keep the old proxy container deployable until verified, and how to cut back if the ALB behaves differently. */}

Expand All @@ -683,7 +683,7 @@
Some apps don't speak HTTP. They speak a gateway protocol, and the proxy in front of them translates:

- **FastCGI**: PHP-FPM and similar process managers. NGINX reaches them with `fastcgi_pass`.
- **uWSGI**: the uwsgi protocol used by many Python apps. NGINX reaches them with `uwsgi_pass`.

Check warning on line 686 in guides/alb-as-httpd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (datum-4926dda5) - vale-spellcheck

guides/alb-as-httpd.mdx#L686

Did you really mean 'uwsgi'?
- **CGI**: older scripts that the web server runs once per request.

The ALB forwards only HTTP, and an Instance runs one container, so a proxy sidecar can't do the translation. You have two options.
Expand All @@ -691,7 +691,7 @@
**Switch to an image that serves HTTP directly.** This is the simpler option. Examples:

- PHP: FrankenPHP, or Apache with `mod_php`
- Python: gunicorn or uvicorn

Check warning on line 694 in guides/alb-as-httpd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (datum-4926dda5) - vale-spellcheck

guides/alb-as-httpd.mdx#L694

Did you really mean 'gunicorn'?

Check warning on line 694 in guides/alb-as-httpd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (datum-4926dda5) - vale-spellcheck

guides/alb-as-httpd.mdx#L694

Did you really mean 'uvicorn'?

Then follow this guide from the start. For details, see [Before you begin](https://github.com/datum-labs/shorts/blob/main/gists/alb/alb-as-httpd-reference.md#before-you-begin) in the reference.

Expand Down Expand Up @@ -740,7 +740,7 @@

## Clean up

After cutover and your rollback window, retire:

Check warning on line 743 in guides/alb-as-httpd.mdx

View check run for this annotation

Mintlify / Mintlify Validation (datum-4926dda5) - vale-spellcheck

guides/alb-as-httpd.mdx#L743

Did you really mean 'cutover'?

- The old proxy container
- Its configuration
Expand Down
2 changes: 1 addition & 1 deletion locations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Datum takes the opposite approach: every Region and Availability Zone correspond
- **Data location** — because each Region maps to a specific country, you can reason about which jurisdiction your workloads run in. Regulatory and export-control requirements can still limit where a workload may run, and they take precedence over the placement rules below.
- **Real choice and control** — you pick where things run based on your own requirements (proximity to users, legal residency, avoiding a single point of failure), the same way you would if you were choosing between physical data centers, rather than accepting one big undifferentiated "everywhere."

Most customers pick a Region close to their users or their required jurisdiction. To add redundancy, or to serve users in more than one part of the world, deploy to more than one Region. To see which Regions your project can use today, see [Check what's available to your project](#check-whats-available-to-your-project).
Most customers pick a Region close to their users or their required jurisdiction. To add redundancy, or to serve users in more than one part of the world, deploy to more than one Region. To see which Regions your project can use today, see [Check what's available to your project](#check-what’s-available-to-your-project).

## Naming convention

Expand Down
Loading