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
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ When a reader is signed in to Datum Cloud, `docs-vars.js` marks these tokens in
| `your-org-id` | The reader's org, e.g. `personal-org-2650fdb4` | `--organization`, the org half of `datumctl ctx use ORG/PROJECT` |
| `your-project-id` | The reader's project, e.g. `my-api` | `--project`, `PROJECT=` variables, project paths in API URLs, sample output that echoes the project |
| `your-email` | The reader's sign-in email | Commands that take the reader's own account, e.g. `datumctl auth switch` |
| `ALB_NAME` | One of the reader's load balancers in the current project, picked on hover when there are several | An existing load balancer: `datumctl alb describe\|logs\|delete\|auth`, `gateway_name=` in metrics |
| `default` | Stays `default` (not replaced) | `--namespace`, `NAMESPACE=`. It is the only namespace Datum supports |

For example:
Expand All @@ -76,7 +77,8 @@ Rules:
- Don't wrap a token in `<…>`. Shiki reads `<` as a shell redirect and splits the token across several spans, so it can't be replaced.
- Replace values only, never variable references: `PROJECT="your-project-id"` uses the token, `--project $PROJECT` stays.
- Use `your-email` only for the reader's own account. Someone else's identity (an audit filter, an allowed-users list) keeps an example address like `alice@example.com`.
- Other placeholders (`ALB_NAME`, `INSTANCE_NAME`, `my-zone`, `example.com`) are fine. They are never replaced, so readers still swap them by hand.
- `ALB_NAME` is for a load balancer that already exists. For a name the reader makes up (`datumctl alb create`), write `NEW_ALB_NAME`, which is never replaced. With one load balancer, `ALB_NAME` is filled in. With several, nothing is filled until the reader picks one, and the pick applies to every `ALB_NAME` on the page.
- Other placeholders (`INSTANCE_NAME`, `my-zone`, `example.com`) are fine. They are never replaced, so readers still swap them by hand.
- Prose that explains flag syntax, like ``--project <project>``, can keep the angle brackets. It isn't a value to copy.

## Spellcheck
Expand Down
6 changes: 3 additions & 3 deletions alb/operations/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@
To create a load balancer in front of an origin, run the following command:

```bash
datumctl alb create ALB_NAME --endpoint ORIGIN_URL
datumctl alb create NEW_ALB_NAME --endpoint ORIGIN_URL
```

Replace the following:

- `ALB_NAME`: a name for the load balancer, such as `my-app`.
- `NEW_ALB_NAME`: a name for the load balancer, such as `my-app`.
- `ORIGIN_URL`: the `http` or `https` URL of your origin, such as `https://origin.example.com`.

The command waits up to 2 minutes for Datum to assign a generated hostname, then prints it:
Expand Down Expand Up @@ -45,7 +45,7 @@
| `--hostname HOSTNAME` | Attaches a custom hostname at create time. See [Serve traffic on your own domain](/alb/operations/custom-domains). |
| `--host-header HOST` | Sets the Host header that Datum sends to the origin. |
| `--tls-hostname HOSTNAME` | Sets the hostname that Datum uses to verify TLS when an `--endpoint` origin is an IP address. |
| `--display-name NAME` | Sets the name shown in the Cloud Portal. If you omit `ALB_NAME`, Datum derives one from the display name. |
| `--display-name NAME` | Sets the name shown in the Cloud Portal. If you omit `NEW_ALB_NAME`, Datum derives one from the display name. |
| `--dry-run` | Validates the load balancer with the API server without creating it. |

For example, to put a load balancer in front of a workload's network service and attach a custom hostname, run the following command:
Expand All @@ -58,7 +58,7 @@

## Inspect a load balancer

To see a load balancer's status, hostnames, routes, traffic protection, and certificates, run the following command:

Check warning on line 61 in alb/operations/overview.mdx

View check run for this annotation

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

alb/operations/overview.mdx#L61

Did you really mean 'balancer's'?

```bash
datumctl alb describe ALB_NAME
Expand Down
Loading
Loading