Project file
One file says what the cluster is.
.aide.yaml is created by aide init and read by every aide cluster command except list and use. --project-file <PATH> selects another file; relative paths inside it resolve from its directory.
project: name: "myproject" domain: "dev.mycompany.io" ca: cert: ./private/ca.crt key: ./private/ca.key ports: - "80:80" - "443:443"
| Key | Meaning |
|---|---|
project.name | Prefix for the cluster, network and resource names. Required |
project.domain | Base domain for the DNS zone and the certificate. Required |
ca.generate, or ca.cert with ca.key | The certificate authority. Use one form; generate: true takes precedence. A generated CA is recreated on every start, so keep a pair for anything you stop and start |
ports | Host port mappings. Empty or omitted means 80:80 and 443:443; a non-empty list replaces both, so list them again if you still want them |
Volumes, network
Volumes, subnet and the optional Service bridge.
| Key | Meaning |
|---|---|
volumes[].name, type, path | A volume that becomes the StorageClass aide-<name>. type is volume (Docker named volume) or bind (host path) |
volumes[].source | The host path. Required for bind and invalid for volume |
charts.* | Pinned versions of the cluster's built-in components. Absent keys use the built-in defaults |
network.subnet | A requested Docker subnet. An existing network that has a gateway is reused without checking it |
network.service_bridge | Off by default. Forwards the cluster.local DNS zone and routes the Service network; use one bridge at a time and stop it before changing or disabling it |
The configuration reference lists every field, and the route reference covers the routing commands in full.
Environment
Channel, credentials and diagnostics.
| Variable | Default | Effect |
|---|---|---|
MAIT_CHANNEL | the channel recorded at install, else stable | stable, edge or beta: selects the service channel and the credentials file |
AIDE_CREDENTIALS_PATH | ~/.mait/credentials[.channel], then /etc/mait/credentials[.channel] | The credentials file written by aide login |
AIDE_UPDATE_COOLDOWN | 600 | Seconds between background update checks. It can only lengthen the interval |
The global flags --verbose and --debug raise output detail for one command.
Next