ConfigDump¶

This documentation is for the Envoy v3 API.

As of Envoy v1.18 the v2 API has been removed and is no longer supported.

If you are upgrading from v2 API config you may wish to view the v2 API documentation:

admin/v2alpha/config_dump.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
endpoints: EndpointsConfigDump
listeners: ListenersConfigDump
scoped_routes: ScopedRoutesConfigDump
routes: RoutesConfigDump
secrets: SecretsConfigDump

EDS Configuration will only be dumped by using parameter ?include_eds

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.UpdateFailureState¶

[admin.v3.UpdateFailureState proto]

{
  "failed_configuration": "{...}",
  "last_update_attempt": "{...}",
  "details": "..."
}

failed_configuration: (Any) What the component configuration would have been if the update had succeeded. This field may not be populated by xDS clients due to storage overhead.

last_update_attempt: (Timestamp) Time of the latest failed update attempt.

details: (string) Details about the last failed update attempt.

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.ListenersConfigDump¶

[admin.v3.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_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: (repeated admin.v3.ListenersConfigDump.StaticListener) The statically loaded listener configs.

dynamic_listeners: (repeated admin.v3.ListenersConfigDump.DynamicListener) State for any warming, active, or draining listeners.

admin.v3.ListenersConfigDump.StaticListener¶

[admin.v3.ListenersConfigDump.StaticListener proto]

Describes a statically loaded listener.

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

listener: (Any) The listener config.

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

admin.v3.ListenersConfigDump.DynamicListenerState¶

[admin.v3.ListenersConfigDump.DynamicListenerState proto]

{
  "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: (Any) The listener config.

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

admin.v3.ListenersConfigDump.DynamicListener¶

[admin.v3.ListenersConfigDump.DynamicListener proto]

Describes a dynamically loaded listener via the LDS API.

{
  "name": "...",
  "active_state": "{...}",
  "warming_state": "{...}",
  "draining_state": "{...}",
  "error_state": "{...}"
}

name: (string) The name or unique id of this listener, pulled from the DynamicListenerState config.

active_state: (admin.v3.ListenersConfigDump.DynamicListenerState) The listener state for any active listener by this name. These are listeners that are available to service data plane traffic.

warming_state: (admin.v3.ListenersConfigDump.DynamicListenerState) The listener state for any warming listener by this name. 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.

draining_state: (admin.v3.ListenersConfigDump.DynamicListenerState) The listener state for any draining listener by this name. 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.

error_state: (admin.v3.UpdateFailureState) Set if the last update failed, cleared after the next successful update. The error_state field contains the rejected version of this particular resource along with the reason and timestamp. For successfully updated or acknowledged resource, this field should be empty.

admin.v3.ClustersConfigDump¶

[admin.v3.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: (repeated admin.v3.ClustersConfigDump.StaticCluster) The statically loaded cluster configs.

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

dynamic_warming_clusters: (repeated admin.v3.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.v3.ClustersConfigDump.StaticCluster¶

[admin.v3.ClustersConfigDump.StaticCluster proto]

Describes a statically loaded cluster.

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

cluster: (Any) The cluster config.

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

admin.v3.ClustersConfigDump.DynamicCluster¶

[admin.v3.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: (Any) The cluster config.

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

admin.v3.RoutesConfigDump¶

[admin.v3.RoutesConfigDump proto]

Envoy’s RDS implementation fills this message with all currently loaded routes, as described by their RouteConfiguration objects. Static routes that are either defined in the bootstrap configuration or defined inline while configuring listeners 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: (repeated admin.v3.RoutesConfigDump.StaticRouteConfig) The statically loaded route configs.

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

admin.v3.RoutesConfigDump.StaticRouteConfig¶

[admin.v3.RoutesConfigDump.StaticRouteConfig proto]

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

route_config: (Any) The route config.

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

admin.v3.RoutesConfigDump.DynamicRouteConfig¶

[admin.v3.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: (Any) The route config.

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

admin.v3.ScopedRoutesConfigDump¶

[admin.v3.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: (repeated admin.v3.ScopedRoutesConfigDump.InlineScopedRouteConfigs) The statically loaded scoped route configs.

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

admin.v3.ScopedRoutesConfigDump.InlineScopedRouteConfigs¶

[admin.v3.ScopedRoutesConfigDump.InlineScopedRouteConfigs proto]

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

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

scoped_route_configs: (repeated Any) The scoped route configurations.

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

admin.v3.ScopedRoutesConfigDump.DynamicScopedRouteConfigs¶

[admin.v3.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: (repeated Any) The scoped route configurations.

last_updated: (Timestamp) The timestamp when the scoped route config set 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.

admin.v3.EndpointsConfigDump¶

[admin.v3.EndpointsConfigDump proto]

Envoy’s admin fill this message with all currently known endpoints. Endpoint configuration information can be used to recreate an Envoy configuration by populating all endpoints as static endpoints or by returning them in an EDS response.

{
  "static_endpoint_configs": [],
  "dynamic_endpoint_configs": []
}

static_endpoint_configs: (repeated admin.v3.EndpointsConfigDump.StaticEndpointConfig) The statically loaded endpoint configs.

dynamic_endpoint_configs: (repeated admin.v3.EndpointsConfigDump.DynamicEndpointConfig) The dynamically loaded endpoint configs.

admin.v3.EndpointsConfigDump.StaticEndpointConfig¶

[admin.v3.EndpointsConfigDump.StaticEndpointConfig proto]

{
  "endpoint_config": "{...}"
}

endpoint_config: (Any) The endpoint config.

admin.v3.EndpointsConfigDump.DynamicEndpointConfig¶

[admin.v3.EndpointsConfigDump.DynamicEndpointConfig proto]

{
  "endpoint_config": "{...}"
}

endpoint_config: (Any) The endpoint config.

Enum admin.v3.ClientResourceStatus¶

[admin.v3.ClientResourceStatus proto]

Resource status from the view of a xDS client, which tells the synchronization status between the xDS client and the xDS server.

UNKNOWN: (DEFAULT) ⁣Resource status is not available/unknown.

REQUESTED: ⁣Client requested this resource but hasn’t received any update from management server. The client will not fail requests, but will queue them until update arrives or the client times out waiting for the resource.

DOES_NOT_EXIST: ⁣This resource has been requested by the client but has either not been delivered by the server or was previously delivered by the server and then subsequently removed from resources provided by the server. For more information, please refer to the “Knowing When a Requested Resource Does Not Exist” section.

ACKED: ⁣Client received this resource and replied with ACK.

NACKED: ⁣Client received this resource and replied with NACK.