Configuration¶
| Group | Pages |
|---|---|
| Start | Loading and global settings, profiles: dev, pilot, production |
| Roles | Authority, Proxy, Connector, Agent host, Client |
| Network and nodes | Endpoints, Enrollment, Transport |
| Access | Identity, Policy, Security, Administration |
| Operations | High availability, Operations, Discovery |
| Agents and integrations | Agents, MCP, Workload |
| Examples | Recipes |
The sections below link to those pages.
Host names such as auth and proxy in examples are placeholders for your
own endpoints. Deployment scenarios show how to set them.
gdsgate reads one TOML configuration file given with --config. A subcommand
is required: gdsgate with no subcommand prints help and exits. A missing
top-level section takes its defaults. A declared nested table or array entry
must still have its required fields. Without a configuration file the loopback
development profile is used. GDSGATE_* variables override the file.
Service and client commands use the same file shape. Each command reads only the sections listed for it below.
| Section or field | Authority | Proxy | Connector | Client or CLI |
|---|---|---|---|---|
| profile | service telemetry and logs | service telemetry and logs | service telemetry and logs | Resident client journal only (up --foreground) |
| security | hold start-up to the declared profile | hold start-up to the declared profile | hold start-up to the declared profile | |
| security.integrity | name the keyrings production requires |
|||
| kms_keys | wrap the two keyrings and the CA signing seeds | |||
| store_url | yes | |||
| store_auto_migrate | yes | |||
| endpoints | bind and advertise Authority listeners | bind Proxy listeners and dial Authority | dial Proxy or Authority | dial the published Proxy endpoint |
| enroll | enroll and renew | enroll and renew | ||
| transport | issue transport identities | terminate transport mTLS | terminate transport mTLS | |
| client | publish client bundle values | consume client addressing and resolver settings | ||
| proxy | bind Proxy and browser listeners | |||
| authority | bind Authority listeners | |||
| policy | load and edit policy | |||
| oidc | validate identities | client sign-in and token refresh | ||
| identity | sanitize human and workload claims | enforce Kubernetes impersonation limits | ||
| workload | issue workload identities | |||
| mcp | seed MCP policy defaults | |||
| mfa | verify and enroll factors | |||
| ca_rotation | rotate configured CAs | |||
| ha | elect the Authority audit writer | |||
| audit | seal, verify, and export audit records | |||
| approvals | resolve JIT thresholds | request or approve access | ||
| discovery | seed the catalog | list published resources | ||
| recording | write session recordings | view through CLI | ||
| telemetry | expose daemon metrics and traces | expose daemon metrics and traces | expose daemon metrics and traces | |
| doctor | periodic checks | periodic checks | periodic checks | manual doctor command |
| admin | operator workstation certificate | |||
| policy.editor | policy-edit quorum | |||
| agent_profiles | delegate --exec profile registry | |||
| delegation_profiles | saved delegation dispatch | |||
| connector | register resources and serve backends |
all starts the Authority, Proxy, and Connector roles together and reads their
sections. It does not read [admin] or the CLI profile entries. See Per-role
recipes for the dispatch map and [Configuration templates]
(../admin-guide.md#configuration-templates) for deployment examples.
Layering¶
Canonical details: Configuration loading and global settings.
Secret references¶
Canonical details: Configuration loading and global settings.
[[kms_keys]]¶
Canonical details: Configuration loading and global settings.
Top level¶
Canonical details: Configuration loading and global settings.
[security]¶
Canonical details: Security configuration.
[security.integrity]¶
Canonical details: Security configuration.
[endpoints]¶
Canonical details: Endpoints configuration.
proxy_join: the join relay¶
Canonical details: Endpoints configuration.
What Authority tells a joining node¶
Canonical details: Endpoints configuration.
[enroll]¶
Canonical details: Enrollment configuration.
Automatic identity renewal¶
Canonical details: Enrollment configuration.
[transport]¶
Canonical details: Transport configuration.
The name a shared front routes on¶
Canonical details: Transport configuration.
[client]¶
Canonical details: Client configuration.
[client.direct]¶
Canonical details: Client configuration.
[client.transparent]¶
Canonical details: Client configuration.
[[client.agent_resources]]¶
Canonical details: Client configuration.
[proxy]¶
Canonical details: Proxy configuration.
public_join: the join on the client-facing port¶
Canonical details: Proxy configuration.
Relayed lanes and their ceilings¶
Canonical details: Proxy configuration.
The clientless browser entry¶
Canonical details: Proxy configuration.
[authority]¶
Canonical details: Authority configuration.
The emergency administrative socket¶
Canonical details: Authority configuration.
[policy]¶
Canonical details: Policy configuration.
[oidc]¶
Canonical details: Identity configuration.
[identity]¶
Canonical details: Identity configuration.
[workload]¶
Canonical details: Workload configuration.
[mcp]¶
Canonical details: MCP configuration.
[mfa]¶
Canonical details: Security configuration.
[ca_rotation]¶
Canonical details: Security configuration.
[ha]¶
Canonical details: High availability configuration.
[audit]¶
Canonical details: Operations configuration.
[telemetry]¶
Canonical details: Operations configuration.
[doctor]¶
Canonical details: Operations configuration.
[admin]¶
Canonical details: Administration configuration.
Administering through the gateway¶
Canonical details: Administration configuration.
[policy.editor]¶
Canonical details: Administration configuration.
[approvals]¶
Canonical details: Administration configuration.
[discovery]¶
Canonical details: Discovery configuration.
[[discovery.resources]]: declared resources¶
Canonical details: Discovery configuration.
[[discovery.import_rules]]: label and environment rules¶
Canonical details: Discovery configuration.
Reserved labels¶
Canonical details: Discovery configuration.
A full discovery example¶
Canonical details: Discovery configuration.
[recording]¶
Canonical details: Operations configuration.
[connector]¶
Canonical details: Connector configuration.
Tunnelled connectors and Authority failover¶
Canonical details: Connector configuration.
[[connector.backends]]: one resource per entry¶
Canonical details: Connector configuration.
[[connector.backends.routes]]: named path families¶
Canonical details: Connector configuration.
Per-kind reference¶
Canonical details: Connector configuration.
Inspecting egress traffic¶
Canonical details: Connector configuration.
The web lane¶
Canonical details: Connector configuration.
Forwarding caller identity to the application¶
Canonical details: Connector configuration.
Recording the exchange¶
Canonical details: Connector configuration.
Running the MCP server as a child process¶
Canonical details: Connector configuration.
The cage¶
Canonical details: Connector configuration.
A remote MCP server over HTTP¶
Canonical details: Connector configuration.
The external decider¶
Canonical details: Connector configuration.
Pinning tool descriptors¶
Canonical details: Connector configuration.
Behavior when Authority is unreachable¶
Canonical details: Connector configuration.
The model lane¶
Canonical details: Connector configuration.
[connector.backends.discovery]¶
Canonical details: Connector configuration.
Forward gating¶
Canonical details: Connector configuration.
[[agent_profiles]]¶
Canonical details: Agents configuration.
[[delegation_profiles]]¶
Canonical details: Agents configuration.
Environment overrides¶
Canonical details: Configuration loading and global settings.
Per-role recipes¶
Canonical details: Configuration recipes.
Authority-only (multi-node, control plane)¶
Canonical details: Configuration recipes.
Proxy-only¶
Canonical details: Configuration recipes.
Connector-only¶
Canonical details: Configuration recipes.
Connector-only, one address (tunneled)¶
Canonical details: Configuration recipes.
Client¶
Canonical details: Configuration recipes.
All-in-one (single-node deployment)¶
Canonical details: Configuration recipes.