ConfigDump¶

admin.v2alpha.ConfigDump¶

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

{
  "configs": "{...}"
}

configs

(map<string, Any>) This map is serialized and dumped in its entirety at the /config_dump endpoint.

Keys are a short descriptor of the config object they map to. The following keys (and the messages they map to) are currently supported:

bootstrap: BootstrapConfigDump
listeners: ListenersConfigDump
clusters: ClustersConfigDump
routes: RoutesConfigDump

admin.v2alpha.BootstrapConfigDump¶

[admin.v2alpha.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": "{...}"
}

bootstrap: (config.bootstrap.v2.Bootstrap)

admin.v2alpha.ListenersConfigDump¶

[admin.v2alpha.ListenersConfigDump proto]

Envoy’s listener manager fills this message with all currently known listeners. Listener configuration information can be used to recreate an Envoy configuration by populating all listeners as static listeners or by returning them in a LDS response.

{
  "version_info": "...",
  "static_listeners": [],
  "dynamic_active_listeners": [],
  "dynamic_warming_listeners": [],
  "dynamic_draining_listeners": []
}

version_info: (string) This is the version_info in the last processed LDS discovery response. If there are only static bootstrap listeners, this field will be “”.

static_listeners: (Listener) The statically loaded listener configs.

dynamic_active_listeners: (admin.v2alpha.ListenersConfigDump.DynamicListener) The dynamically loaded active listeners. These are listeners that are available to service data plane traffic.

dynamic_warming_listeners: (admin.v2alpha.ListenersConfigDump.DynamicListener) The dynamically loaded warming listeners. These are listeners that are currently undergoing warming in preparation to service data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the warming listeners should generally be discarded.

dynamic_draining_listeners: (admin.v2alpha.ListenersConfigDump.DynamicListener) The dynamically loaded draining listeners. These are listeners that are currently undergoing draining in preparation to stop servicing data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the draining listeners should generally be discarded.

admin.v2alpha.ListenersConfigDump.DynamicListener¶

[admin.v2alpha.ListenersConfigDump.DynamicListener proto]

Describes a dynamically loaded cluster via the LDS API.

{
  "version_info": "...",
  "listener": "{...}"
}

version_info: (string) This is the per-resource version information. This version is currently taken from the version_info field at the time that the listener was loaded. In the future, discrete per-listener versions may be supported by the API.

listener: (Listener) The listener config.

admin.v2alpha.ClustersConfigDump¶

[admin.v2alpha.ClustersConfigDump proto]

Envoy’s cluster manager fills this message with all currently known clusters. Cluster configuration information can be used to recreate an Envoy configuration by populating all clusters as static clusters or by returning them in a CDS response.

{
  "version_info": "...",
  "static_clusters": [],
  "dynamic_active_clusters": [],
  "dynamic_warming_clusters": []
}

version_info: (string) This is the version_info in the last processed CDS discovery response. If there are only static bootstrap clusters, this field will be “”.

static_clusters: (Cluster) The statically loaded cluster configs.

dynamic_active_clusters: (admin.v2alpha.ClustersConfigDump.DynamicCluster) The dynamically loaded active clusters. These are clusters that are available to service data plane traffic.

dynamic_warming_clusters: (admin.v2alpha.ClustersConfigDump.DynamicCluster) The dynamically loaded warming clusters. These are clusters that are currently undergoing warming in preparation to service data plane traffic. Note that if attempting to recreate an Envoy configuration from a configuration dump, the warming clusters should generally be discarded.

admin.v2alpha.ClustersConfigDump.DynamicCluster¶

[admin.v2alpha.ClustersConfigDump.DynamicCluster proto]

Describes a dynamically loaded cluster via the CDS API.

{
  "version_info": "...",
  "cluster": "{...}"
}

version_info: (string) This is the per-resource version information. This version is currently taken from the version_info field at the time that the cluster was loaded. In the future, discrete per-cluster versions may be supported by the API.

cluster: (Cluster) The cluster config.

admin.v2alpha.RoutesConfigDump¶

[admin.v2alpha.RoutesConfigDump proto]

Envoy’s RDS implementation fills this message with all currently loaded routes, as described by their RouteConfiguration objects. Static routes configured in the bootstrap configuration are separated from those configured dynamically via RDS. Route configuration information can be used to recreate an Envoy configuration by populating all routes as static routes or by returning them in RDS responses.

{
  "static_route_configs": [],
  "dynamic_route_configs": []
}

static_route_configs: (RouteConfiguration) The statically loaded route configs.

dynamic_route_configs: (admin.v2alpha.RoutesConfigDump.DynamicRouteConfig) The dynamically loaded route configs.

admin.v2alpha.RoutesConfigDump.DynamicRouteConfig¶

[admin.v2alpha.RoutesConfigDump.DynamicRouteConfig proto]

{
  "version_info": "...",
  "route_config": "{...}"
}

version_info: (string) This is the per-resource version information. This version is currently taken from the version_info field at the time that the route configuration was loaded.

route_config: (RouteConfiguration) The route config.