Skip to content
Open
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
2 changes: 1 addition & 1 deletion alb/observability.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Status and metrics

The load balancer's overview in the [Cloud Portal](https://cloud.datum.net) shows whether it is serving, the live request rate, error rate, latency, and requests blocked by the firewall. Its **Metrics** tab breaks these down by location, response code, and firewall rule. With `datumctl`, run `datumctl alb describe ALB_NAME` for status, hostnames, and certificates:

Check warning on line 11 in alb/observability.mdx

View check run for this annotation

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

alb/observability.mdx#L11

Did you really mean 'balancer's'?

```text
$ datumctl alb describe api
Expand Down Expand Up @@ -39,7 +39,7 @@

| Label | Meaning |
| --- | --- |
| `gateway_name` | The load balancer's name, as shown by `datumctl alb list`. |

Check warning on line 42 in alb/observability.mdx

View check run for this annotation

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

alb/observability.mdx#L42

Did you really mean 'balancer's'?
| `envoy_response_code` | The HTTP response code, such as `200` or `503`. |
| `label_topology_kubernetes_io_region` | The Datum location that served the request, such as `us-west-1`. |
| `resourcemanager_datumapis_com_project_name` | Your project ID. |
Expand All @@ -64,7 +64,7 @@

| Metric | What it reports |
| --- | --- |
| `datum_cloud_networking_http_proxy_status_condition` | `1` when a condition is true. The `condition` label is `Accepted` or `Programmed`, and `reason` explains it. `resource_name` is the load balancer's name. |

Check warning on line 67 in alb/observability.mdx

View check run for this annotation

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

alb/observability.mdx#L67

Did you really mean 'balancer's'?
| `datum_cloud_networking_http_proxy_custom_hostname` | One series for each custom hostname, in the `hostname` label. |

### Example queries
Expand Down Expand Up @@ -103,7 +103,7 @@
)
```

Datum also publishes prebuilt Grafana dashboards for these metrics. See [Datum dashboards in Grafana Cloud](/operations/metrics-export#datum-dashboards-in-grafana-cloud).

Check warning on line 106 in alb/observability.mdx

View check run for this annotation

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

alb/observability.mdx#L106

Did you really mean 'Grafana'?

## Access logs

Expand All @@ -119,7 +119,7 @@
01:29:34 GET 302 / bright-oak-4f7k2.datumproxy.net 7ms
```

In the Cloud Portal, a load balancer's **Logs** tab shows the same requests, with filters for time range, method, status code, and host.

Check warning on line 122 in alb/observability.mdx

View check run for this annotation

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

alb/observability.mdx#L122

Did you really mean 'balancer's'?

<Frame caption="Access logs in the Cloud Portal, including a request the firewall blocked with 403">
![The Logs tab of a load balancer, with filters on the left and a table of requests showing time, status, host, and path, including 404 responses and a 403 for a SQL injection attempt](/images/alb-logs-portal.png)
Expand All @@ -142,7 +142,7 @@

### Query access logs across load balancers

The `telemetry` plugin queries every log line in your project, including load balancer access logs, with a [LogQL](https://grafana.com/docs/loki/latest/query/) stream selector. To install it, run `datumctl plugin install telemetry`. For example, to see every request that any load balancer in the project answered with `403`:
The `telemetry` plugin queries every log line in your project, including load balancer access logs, with a [LogQL](https://grafana.com/docs/loki/latest/query/) stream selector. To install it, add the Milo catalog with `datumctl plugin index add milo-os milo-os/cli-plugins`, then run `datumctl plugin install milo-os/telemetry`. For example, to see every request that any load balancer in the project answered with `403`:

```bash
datumctl telemetry logs '{response_code="403"}' --since 1h
Expand Down
5 changes: 3 additions & 2 deletions datumctl/ai/assistant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,11 @@ description: "Chat with Patch, the Datum Cloud assistant, from the terminal: ask

Patch is the Datum Cloud assistant. Ask it about your resources in plain language, such as "why is my workload not available?" or "is my load balancer serving?", and it answers using the same permissions your account already has. There's no API key to bring and nothing to configure.

`datumctl assistant` is a [plugin](/datumctl/plugins/using-plugins), so it updates on its own schedule. To install it, run the following command:
`datumctl assistant` is a [plugin](/datumctl/plugins/using-plugins) from the Milo catalog, so it updates on its own schedule. To install it, add the catalog and install the plugin:

```bash
datumctl plugin install assistant
datumctl plugin index add milo-os milo-os/cli-plugins
datumctl plugin install milo-os/assistant
```

## Start a conversation
Expand Down
2 changes: 1 addition & 1 deletion datumctl/discovering-resources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ Discovery feeds directly into authoring manifests for `datumctl apply` and

## Search across your resources

When you know roughly what you're looking for but not its kind or exact name, use the `search` plugin. It searches your resources by name and kind, and returns the best matches first. To install it, run `datumctl plugin install search`.
When you know roughly what you're looking for but not its kind or exact name, use the `search` plugin. It searches your resources by name and kind, and returns the best matches first. To install it, add the Milo catalog with `datumctl plugin index add milo-os milo-os/cli-plugins`, then run `datumctl plugin install milo-os/search`.

```text
$ datumctl search api
Expand Down
7 changes: 7 additions & 0 deletions datumctl/plugins/using-plugins.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -186,9 +186,16 @@
- `datumctl plugin search` adds `[deprecated]` before the description and prints the warning for each deprecated result to stderr after the table. With `-o json`, each deprecated result carries a `deprecated` object instead. `-o json` and `-o name` print no warnings.
- `datumctl plugin browse` adds `(deprecated)` after the plugin name and shows the warning in the plugin's details.

The `assistant`, `billing`, `ipam`, `search`, and `telemetry` plugins have moved from the **datum** catalog to the [Milo catalog](https://github.com/milo-os/cli-plugins), and their **datum** entries are deprecated. They keep installing from the **datum** catalog until Datum removes them. datumctl v0.25.0 and later shows the deprecation warning for them. To switch a plugin, add the Milo catalog and install the plugin from it:

```bash
datumctl plugin index add milo-os milo-os/cli-plugins
datumctl plugin install milo-os/telemetry
```

## How plugins stay trustworthy

datumctl treats a plugin as untrusted code and protects you in a few ways:

Check warning on line 198 in datumctl/plugins/using-plugins.mdx

View check run for this annotation

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

datumctl/plugins/using-plugins.mdx#L198

Did you really mean 'untrusted'?

- **HTTPS-only downloads.** Plugin archives and catalog manifests are fetched over HTTPS only. Downloads to private, loopback, or link-local addresses are refused, and redirects are re-checked on every hop.
- **Checksum verification on every run.** datumctl records a SHA256 fingerprint of each plugin binary at install time and verifies it *every time the plugin runs*. If a managed plugin binary is modified after installation, datumctl refuses to run it.
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 @@ -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 @@ -634,7 +634,7 @@

`UPSTREAM` is the Instance's private address, which matches the `INTERNAL IP` column of `datumctl compute instances`.

For every Envoy field, including `response_flags`, query the logs with the `telemetry` plugin. To install it, run `datumctl plugin install telemetry`. A query is a [LogQL](https://grafana.com/docs/loki/latest/query/) stream selector, and without a hostname it matches every ALB in the project. To see the `504` responses for one ALB, match its hostname with the `authority` label:
For every Envoy field, including `response_flags`, query the logs with the `telemetry` plugin. To install it, add the Milo catalog with `datumctl plugin index add milo-os milo-os/cli-plugins`, then run `datumctl plugin install milo-os/telemetry`. A query is a [LogQL](https://grafana.com/docs/loki/latest/query/) stream selector, and without a hostname it matches every ALB in the project. To see the `504` responses for one ALB, match its hostname with the `authority` label:

```bash
datumctl telemetry logs '{authority="tile-desire-9gpyk.datumproxy.net", response_code="504"}' --since 1h
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
3 changes: 2 additions & 1 deletion operations/datum-assistant.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ Patch uses diagnostic tools from the Datum services your project uses, so it can
Patch is available in the terminal with `datumctl assistant`. Conversations are kept by Datum, so you can pick one up from any machine you're signed in on.

```bash
datumctl plugin install assistant
datumctl plugin index add milo-os milo-os/cli-plugins
datumctl plugin install milo-os/assistant
datumctl assistant chat "Why is the api-backend workload not available?"
```

Expand Down
Loading