brain read from and publish
to Atlan Agent Registry. This page lists what it adds. For brain’s own
commands, see the brain CLI reference.
Install and update
brain checks the adapter’s signature and checksum before it installs it, and
checks the checksum again each time it loads it. A brain you built from
source has no signed origin, so it can’t install the adapter.
When brain updates itself in the background, it updates the adapter too.
Addresses it accepts
The adapter handles registry addresses onatlan.com, atlan.dev, and
atlan.engineering, and their subdomains. The address must:
- start with
https://; - have no user name or password, path, query, or fragment.
https://api.atlan.com unless your Atlan contact gave you a different
address. brain picks the Atlan adapter for these addresses on its own, so you
don’t need --adapter atlan.
Settings
Set these underconfig in a registry’s declaration, or with --config on
brain registry add. The adapter refuses any other key, so a misspelled key
fails instead of being ignored.
Sign-in and tokens
Signing in onboards you to Atlan Agent Registry, so it needs a token for a
person. A service account’s API key works only as
REGISTRY_TOKEN_<NAME>.
For how brain names, stores, and chooses between tokens, see the
brain CLI reference.
What it installs and publishes
Commands it adds
These appear only on a machine with the adapter installed.
Options for
brain trace:
Background jobs it adds
The adapter adds two kinds of job tobrain job add. Both need
--account <registry>. brain help job add doesn’t list them yet.
Environment variables
For every other
brain variable, see the
brain CLI reference.
Usage and crash reporting
brain sends nothing on its own. Installing the Atlan adapter turns on two
kinds of reporting:
- Usage events. Counts of what is installed, how runs and commands ended, and which versions are running. After you sign in, they carry your organization and user IDs.
- Crash reports. Error details with an anonymous ID that isn’t linked to your usage events.
brain telemetry status to see what is on, and brain telemetry off to
turn both off.
Exit statuses
The adapter usesbrain’s exit statuses, listed in the
brain CLI reference. One case is specific to
Atlan: when Atlan refuses the token you piped in, brain auth login exits with
status 1 and shows HTTP 401.
See Errors with Atlan.