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

(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
listeners: ListenersConfigDump
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": "{...}",
  "last_updated": "{...}"
}

bootstrap: (config.bootstrap.v2.Bootstrap)

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

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: (admin.v2alpha.ListenersConfigDump.StaticListener) 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.StaticListener¶

[admin.v2alpha.ListenersConfigDump.StaticListener proto]

Describes a statically loaded cluster.

{
  "listener": "{...}",
  "last_updated": "{...}"
}

listener: (Listener) The listener config.

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

admin.v2alpha.ListenersConfigDump.DynamicListener¶

[admin.v2alpha.ListenersConfigDump.DynamicListener proto]

Describes a dynamically loaded cluster via the LDS API.

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

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.

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

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: (admin.v2alpha.ClustersConfigDump.StaticCluster) 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.StaticCluster¶

[admin.v2alpha.ClustersConfigDump.StaticCluster proto]

Describes a statically loaded cluster.

{
  "cluster": "{...}",
  "last_updated": "{...}"
}

cluster: (Cluster) The cluster config.

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

admin.v2alpha.ClustersConfigDump.DynamicCluster¶

[admin.v2alpha.ClustersConfigDump.DynamicCluster proto]

Describes a dynamically loaded cluster via the CDS API.

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

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.

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

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: (admin.v2alpha.RoutesConfigDump.StaticRouteConfig) The statically loaded route configs.

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

admin.v2alpha.RoutesConfigDump.StaticRouteConfig¶

[admin.v2alpha.RoutesConfigDump.StaticRouteConfig proto]

{
  "route_config": "{...}",
  "last_updated": "{...}"
}

route_config: (RouteConfiguration) The route config.

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

admin.v2alpha.RoutesConfigDump.DynamicRouteConfig¶

[admin.v2alpha.RoutesConfigDump.DynamicRouteConfig proto]

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

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.

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

admin.v2alpha.ScopedRoutesConfigDump¶

[admin.v2alpha.ScopedRoutesConfigDump proto]

Envoy’s scoped RDS implementation fills this message with all currently loaded route configuration scopes (defined via ScopedRouteConfigurationsSet protos). This message lists both the scopes defined inline with the higher order object (i.e., the HttpConnectionManager) and the dynamically obtained scopes via the SRDS API.

{
  "inline_scoped_route_configs": [],
  "dynamic_scoped_route_configs": []
}

inline_scoped_route_configs: (admin.v2alpha.ScopedRoutesConfigDump.InlineScopedRouteConfigs) The statically loaded scoped route configs.

dynamic_scoped_route_configs: (admin.v2alpha.ScopedRoutesConfigDump.DynamicScopedRouteConfigs) The dynamically loaded scoped route configs.

admin.v2alpha.ScopedRoutesConfigDump.InlineScopedRouteConfigs¶

[admin.v2alpha.ScopedRoutesConfigDump.InlineScopedRouteConfigs proto]

{
  "name": "...",
  "scoped_route_configs": [],
  "last_updated": "{...}"
}

name: (string) The name assigned to the scoped route configurations.

scoped_route_configs: (ScopedRouteConfiguration) The scoped route configurations.

last_updated: (Timestamp) The timestamp when the scoped route config set was last updated.

admin.v2alpha.ScopedRoutesConfigDump.DynamicScopedRouteConfigs¶

[admin.v2alpha.ScopedRoutesConfigDump.DynamicScopedRouteConfigs proto]

{
  "name": "...",
  "version_info": "...",
  "scoped_route_configs": [],
  "last_updated": "{...}"
}

name: (string) The name assigned to the scoped route configurations.

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 scoped routes configuration was loaded.

scoped_route_configs: (ScopedRouteConfiguration) The scoped route configurations.

last_updated: (Timestamp) The timestamp when the scoped route config set was last updated.