ConfigDump (proto)¶

admin.v3.ConfigDump¶

The /config_dump admin endpoint uses this wrapper message to maintain and serve arbitrary configuration information from any component in Envoy.

{
  "configs": []
}

configs

(repeated Any) This list is serialized and dumped in its entirety at the /config_dump endpoint.

The following configurations are currently supported and will be dumped in the order given below:

bootstrap: BootstrapConfigDump
clusters: ClustersConfigDump
ecds_filter_http: EcdsConfigDump
ecds_filter_tcp_listener: EcdsConfigDump
endpoints: EndpointsConfigDump
listeners: ListenersConfigDump
scoped_routes: ScopedRoutesConfigDump
routes: RoutesConfigDump
secrets: SecretsConfigDump

EDS Configuration will only be dumped by using parameter ?include_eds

Currently ECDS is supported in HTTP and listener filters. Note, ECDS configuration for either HTTP or listener filter will only be dumped if it is actually configured.

You can filter output with the resource and mask query parameters. See /config_dump?resource={}, /config_dump?mask={}, or /config_dump?resource={},mask={} for more information.

admin.v3.BootstrapConfigDump¶

[admin.v3.BootstrapConfigDump proto]

This message describes the bootstrap configuration that Envoy was started with. This includes any CLI overrides that were merged. Bootstrap configuration information can be used to recreate the static portions of an Envoy configuration by reusing the output as the bootstrap configuration for another Envoy.

{
  "bootstrap": {...},
  "last_updated": {...}
}

bootstrap: (config.bootstrap.v3.Bootstrap)

last_updated: (Timestamp) The timestamp when the BootstrapConfig was last updated.

admin.v3.SecretsConfigDump¶

[admin.v3.SecretsConfigDump proto]

Envoys SDS implementation fills this message with all secrets fetched dynamically via SDS.

{
  "static_secrets": [],
  "dynamic_active_secrets": [],
  "dynamic_warming_secrets": []
}

static_secrets: (repeated admin.v3.SecretsConfigDump.StaticSecret) The statically loaded secrets.

dynamic_active_secrets: (repeated admin.v3.SecretsConfigDump.DynamicSecret) The dynamically loaded active secrets. These are secrets that are available to service clusters or listeners.

dynamic_warming_secrets: (repeated admin.v3.SecretsConfigDump.DynamicSecret) The dynamically loaded warming secrets. These are secrets that are currently undergoing warming in preparation to service clusters or listeners.

admin.v3.SecretsConfigDump.DynamicSecret¶

[admin.v3.SecretsConfigDump.DynamicSecret proto]

DynamicSecret contains secret information fetched via SDS.

{
  "name": ...,
  "version_info": ...,
  "last_updated": {...},
  "secret": {...}
}

name: (string) The name assigned to the secret.

version_info: (string) This is the per-resource version information.

last_updated: (Timestamp) The timestamp when the secret was last updated.

secret: (Any) The actual secret information. Security sensitive information is redacted (replaced with “[redacted]”) for private keys and passwords in TLS certificates.

admin.v3.SecretsConfigDump.StaticSecret¶

[admin.v3.SecretsConfigDump.StaticSecret proto]

StaticSecret specifies statically loaded secret in bootstrap.

{
  "name": ...,
  "last_updated": {...},
  "secret": {...}
}

name: (string) The name assigned to the secret.

last_updated: (Timestamp) The timestamp when the secret was last updated.

secret: (Any) The actual secret information. Security sensitive information is redacted (replaced with “[redacted]”) for private keys and passwords in TLS certificates.