Skip to content

Commit

Permalink
docs envoy@276ba4b8cb39ce47c9027d9747d91364939236c0
Browse files Browse the repository at this point in the history
  • Loading branch information
envoy-docs(travis) committed Mar 20, 2020
1 parent a91ae37 commit 6496672
Show file tree
Hide file tree
Showing 991 changed files with 3,725 additions and 3,725 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Certificates
admin.v2alpha.Certificates
--------------------------

`[admin.v2alpha.Certificates proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/certs.proto#L15>`_
`[admin.v2alpha.Certificates proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/certs.proto#L15>`_

Proto representation of certificate details. Admin endpoint uses this wrapper for `/certs` to
display certificate information. See :ref:`/certs <operations_admin_interface_certs>` for more
Expand All @@ -34,7 +34,7 @@ certificates
admin.v2alpha.Certificate
-------------------------

`[admin.v2alpha.Certificate proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/certs.proto#L20>`_
`[admin.v2alpha.Certificate proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/certs.proto#L20>`_


.. code-block:: json
Expand Down Expand Up @@ -63,7 +63,7 @@ cert_chain
admin.v2alpha.CertificateDetails
--------------------------------

`[admin.v2alpha.CertificateDetails proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/certs.proto#L29>`_
`[admin.v2alpha.CertificateDetails proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/certs.proto#L29>`_


.. code-block:: json
Expand Down Expand Up @@ -120,7 +120,7 @@ expiration_time
admin.v2alpha.SubjectAlternateName
----------------------------------

`[admin.v2alpha.SubjectAlternateName proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/certs.proto#L49>`_
`[admin.v2alpha.SubjectAlternateName proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/certs.proto#L49>`_


.. code-block:: json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Clusters
admin.v2alpha.Clusters
----------------------

`[admin.v2alpha.Clusters proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/clusters.proto#L18>`_
`[admin.v2alpha.Clusters proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/clusters.proto#L18>`_

Admin endpoint uses this wrapper for `/clusters` to display cluster status information.
See :ref:`/clusters <operations_admin_interface_clusters>` for more information.
Expand All @@ -33,7 +33,7 @@ cluster_statuses
admin.v2alpha.ClusterStatus
---------------------------

`[admin.v2alpha.ClusterStatus proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/clusters.proto#L25>`_
`[admin.v2alpha.ClusterStatus proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/clusters.proto#L25>`_

Details an individual cluster's current status.

Expand Down Expand Up @@ -114,7 +114,7 @@ local_origin_success_rate_ejection_threshold
admin.v2alpha.HostStatus
------------------------

`[admin.v2alpha.HostStatus proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/clusters.proto#L74>`_
`[admin.v2alpha.HostStatus proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/clusters.proto#L74>`_

Current state of a particular host.

Expand Down Expand Up @@ -216,7 +216,7 @@ locality
admin.v2alpha.HostHealthStatus
------------------------------

`[admin.v2alpha.HostHealthStatus proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/clusters.proto#L128>`_
`[admin.v2alpha.HostHealthStatus proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/clusters.proto#L128>`_

Health status for a host.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ConfigDump
admin.v2alpha.ConfigDump
------------------------

`[admin.v2alpha.ConfigDump proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L17>`_
`[admin.v2alpha.ConfigDump proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L17>`_

The :ref:`/config_dump <operations_admin_interface_config_dump>` admin endpoint uses this wrapper
message to maintain and serve arbitrary configuration information from any component in Envoy.
Expand Down Expand Up @@ -48,7 +48,7 @@ configs
admin.v2alpha.UpdateFailureState
--------------------------------

`[admin.v2alpha.UpdateFailureState proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L37>`_
`[admin.v2alpha.UpdateFailureState proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L37>`_


.. code-block:: json
Expand Down Expand Up @@ -84,7 +84,7 @@ details
admin.v2alpha.BootstrapConfigDump
---------------------------------

`[admin.v2alpha.BootstrapConfigDump proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L52>`_
`[admin.v2alpha.BootstrapConfigDump proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L52>`_

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
Expand Down Expand Up @@ -116,7 +116,7 @@ last_updated
admin.v2alpha.ListenersConfigDump
---------------------------------

`[admin.v2alpha.ListenersConfigDump proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L62>`_
`[admin.v2alpha.ListenersConfigDump proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L62>`_

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
Expand Down Expand Up @@ -155,7 +155,7 @@ dynamic_listeners
admin.v2alpha.ListenersConfigDump.StaticListener
------------------------------------------------

`[admin.v2alpha.ListenersConfigDump.StaticListener proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L64>`_
`[admin.v2alpha.ListenersConfigDump.StaticListener proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L64>`_

Describes a statically loaded listener.

Expand Down Expand Up @@ -185,7 +185,7 @@ last_updated
admin.v2alpha.ListenersConfigDump.DynamicListenerState
------------------------------------------------------

`[admin.v2alpha.ListenersConfigDump.DynamicListenerState proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L72>`_
`[admin.v2alpha.ListenersConfigDump.DynamicListenerState proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L72>`_


.. code-block:: json
Expand Down Expand Up @@ -224,7 +224,7 @@ last_updated
admin.v2alpha.ListenersConfigDump.DynamicListener
-------------------------------------------------

`[admin.v2alpha.ListenersConfigDump.DynamicListener proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L88>`_
`[admin.v2alpha.ListenersConfigDump.DynamicListener proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L88>`_

Describes a dynamically loaded listener via the LDS API.

Expand Down Expand Up @@ -283,7 +283,7 @@ error_state
admin.v2alpha.ClustersConfigDump
--------------------------------

`[admin.v2alpha.ClustersConfigDump proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L127>`_
`[admin.v2alpha.ClustersConfigDump proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L127>`_

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
Expand Down Expand Up @@ -333,7 +333,7 @@ dynamic_warming_clusters
admin.v2alpha.ClustersConfigDump.StaticCluster
----------------------------------------------

`[admin.v2alpha.ClustersConfigDump.StaticCluster proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L129>`_
`[admin.v2alpha.ClustersConfigDump.StaticCluster proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L129>`_

Describes a statically loaded cluster.

Expand Down Expand Up @@ -363,7 +363,7 @@ last_updated
admin.v2alpha.ClustersConfigDump.DynamicCluster
-----------------------------------------------

`[admin.v2alpha.ClustersConfigDump.DynamicCluster proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L138>`_
`[admin.v2alpha.ClustersConfigDump.DynamicCluster proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L138>`_

Describes a dynamically loaded cluster via the CDS API.

Expand Down Expand Up @@ -404,7 +404,7 @@ last_updated
admin.v2alpha.RoutesConfigDump
------------------------------

`[admin.v2alpha.RoutesConfigDump proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L176>`_
`[admin.v2alpha.RoutesConfigDump proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L176>`_

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
Expand Down Expand Up @@ -436,7 +436,7 @@ dynamic_route_configs
admin.v2alpha.RoutesConfigDump.StaticRouteConfig
------------------------------------------------

`[admin.v2alpha.RoutesConfigDump.StaticRouteConfig proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L177>`_
`[admin.v2alpha.RoutesConfigDump.StaticRouteConfig proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L177>`_


.. code-block:: json
Expand Down Expand Up @@ -465,7 +465,7 @@ last_updated
admin.v2alpha.RoutesConfigDump.DynamicRouteConfig
-------------------------------------------------

`[admin.v2alpha.RoutesConfigDump.DynamicRouteConfig proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L185>`_
`[admin.v2alpha.RoutesConfigDump.DynamicRouteConfig proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L185>`_


.. code-block:: json
Expand Down Expand Up @@ -504,7 +504,7 @@ last_updated
admin.v2alpha.ScopedRoutesConfigDump
------------------------------------

`[admin.v2alpha.ScopedRoutesConfigDump proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L209>`_
`[admin.v2alpha.ScopedRoutesConfigDump proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L209>`_

Envoy's scoped RDS implementation fills this message with all currently loaded route
configuration scopes (defined via ScopedRouteConfigurationsSet protos). This message lists both
Expand Down Expand Up @@ -535,7 +535,7 @@ dynamic_scoped_route_configs
admin.v2alpha.ScopedRoutesConfigDump.InlineScopedRouteConfigs
-------------------------------------------------------------

`[admin.v2alpha.ScopedRoutesConfigDump.InlineScopedRouteConfigs proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L210>`_
`[admin.v2alpha.ScopedRoutesConfigDump.InlineScopedRouteConfigs proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L210>`_


.. code-block:: json
Expand Down Expand Up @@ -571,7 +571,7 @@ last_updated
admin.v2alpha.ScopedRoutesConfigDump.DynamicScopedRouteConfigs
--------------------------------------------------------------

`[admin.v2alpha.ScopedRoutesConfigDump.DynamicScopedRouteConfigs proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L221>`_
`[admin.v2alpha.ScopedRoutesConfigDump.DynamicScopedRouteConfigs proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L221>`_


.. code-block:: json
Expand Down Expand Up @@ -617,7 +617,7 @@ last_updated
admin.v2alpha.SecretsConfigDump
-------------------------------

`[admin.v2alpha.SecretsConfigDump proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L245>`_
`[admin.v2alpha.SecretsConfigDump proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L245>`_

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

Expand Down Expand Up @@ -654,7 +654,7 @@ dynamic_warming_secrets
admin.v2alpha.SecretsConfigDump.DynamicSecret
---------------------------------------------

`[admin.v2alpha.SecretsConfigDump.DynamicSecret proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L247>`_
`[admin.v2alpha.SecretsConfigDump.DynamicSecret proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L247>`_

DynamicSecret contains secret information fetched via SDS.

Expand Down Expand Up @@ -700,7 +700,7 @@ secret
admin.v2alpha.SecretsConfigDump.StaticSecret
--------------------------------------------

`[admin.v2alpha.SecretsConfigDump.StaticSecret proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/config_dump.proto#L264>`_
`[admin.v2alpha.SecretsConfigDump.StaticSecret proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/config_dump.proto#L264>`_

StaticSecret specifies statically loaded secret in bootstrap.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Listeners
admin.v2alpha.Listeners
-----------------------

`[admin.v2alpha.Listeners proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/listeners.proto#L14>`_
`[admin.v2alpha.Listeners proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/listeners.proto#L14>`_

Admin endpoint uses this wrapper for `/listeners` to display listener status information.
See :ref:`/listeners <operations_admin_interface_listeners>` for more information.
Expand All @@ -33,7 +33,7 @@ listener_statuses
admin.v2alpha.ListenerStatus
----------------------------

`[admin.v2alpha.ListenerStatus proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/listeners.proto#L20>`_
`[admin.v2alpha.ListenerStatus proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/listeners.proto#L20>`_

Details an individual listener's current status.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Memory
admin.v2alpha.Memory
--------------------

`[admin.v2alpha.Memory proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/memory.proto#L14>`_
`[admin.v2alpha.Memory proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/memory.proto#L14>`_

Proto representation of the internal memory consumption of an Envoy instance. These represent
values extracted from an internal TCMalloc instance. For more information, see the section of the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Metrics
admin.v2alpha.SimpleMetric
--------------------------

`[admin.v2alpha.SimpleMetric proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/metrics.proto#L11>`_
`[admin.v2alpha.SimpleMetric proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/metrics.proto#L11>`_

Proto representation of an Envoy Counter or Gauge value.

Expand Down Expand Up @@ -45,7 +45,7 @@ name
Enum admin.v2alpha.SimpleMetric.Type
------------------------------------

`[admin.v2alpha.SimpleMetric.Type proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/metrics.proto#L12>`_
`[admin.v2alpha.SimpleMetric.Type proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/metrics.proto#L12>`_


.. _envoy_api_enum_value_admin.v2alpha.SimpleMetric.Type.COUNTER:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ MutexStats
admin.v2alpha.MutexStats
------------------------

`[admin.v2alpha.MutexStats proto] <https://github.com/envoyproxy/envoy/blob/225b8b68510d62ab87d645ef97649845c3967034/api/envoy/admin/v2alpha/mutex_stats.proto#L17>`_
`[admin.v2alpha.MutexStats proto] <https://github.com/envoyproxy/envoy/blob/276ba4b8cb39ce47c9027d9747d91364939236c0/api/envoy/admin/v2alpha/mutex_stats.proto#L17>`_

Proto representation of the statistics collected upon absl::Mutex contention, if Envoy is run
under :option:`--enable-mutex-tracing`. For more information, see the `absl::Mutex`
Expand Down
Loading

0 comments on commit 6496672

Please sign in to comment.