Atlas configuration
Use Atlas Settings for regional configuration. Set the site value atlas_base_url to an address hosts can reach for Atlas files.
Settings by purpose
| Group | What it controls | Important effect |
|---|---|---|
| Region and provider | Region identity, provider adapter, host catalog defaults, and credentials. | New hosts and signed regional identities use these values. |
| Host and network | Private network range, MTU, unicast mesh mode, and Metal endpoint choice. | Host setup and sync use these values. |
| Placement | Strategy, sleepy VM pool, overcommit factor, and host auto-spawn. | New VM capacity checks and host expansion use these values. |
| Trust | Metal certificate authority, Atlas client certificate, regional signing key, and Central public key source. | Atlas, Metal, and service clients use these credentials. |
| Proxy and DNS | Wildcard domain, certificate, proxy password, and DNS access. | Proxy nodes receive updated configuration. |
| Images and storage | Object storage endpoint, bucket, credentials, and signed URL life. | Atlas issues artifact URLs and migrates bootstrap images. |
Apply settings changes
Save validates the provider and placement settings.
| Change | Effect |
|---|---|
| Region ID | Refused while VMs or non-archived proxy records exist. |
| Proxy credentials or certificate | Queues configuration updates for active proxies. |
| Object-storage fields | Queues migration of eligible Site File images. |
Credentials and host access
Atlas creates regional signing and Metal trust material as part of settings setup. Secret keys and passwords use Frappe Password fields. Do not copy them into logs or documentation. A host receives its own certificate during installation.
Signing keys and tokens explains the Central JWKS URL, the combined regional key set, and the separate service audiences.
| Network setting | Purpose |
|---|---|
use_public_ip_for_metald | Selects the Atlas-facing Metal endpoint where supported. It leaves node-to-node WireGuard unchanged. |
is_unicast_network_enabled | Uses unicast discovery when the host network cannot carry multicast. |
Limits and recovery
Saving a field does not prove that every host applied it. Setup, sync, or service configuration may still need to run.
Verify hosts and services after changing region identity, trust material, storage credentials, or public-address mode.
Source code and tests
- Atlas Settings schema lists fields and defaults.
- Atlas Settings controller validates values and queues dependent work.
- Provider registry selects the host adapter.
- Host installation writes Metal host configuration.
- Host sync applies regional host policy.