You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
67 lines
2.1 KiB
67 lines
2.1 KiB
.. _config_cluster_manager: |
|
|
|
Cluster manager |
|
=============== |
|
|
|
.. toctree:: |
|
:hidden: |
|
|
|
cluster |
|
sds |
|
sds_api |
|
outlier |
|
cds |
|
|
|
Cluster manager :ref:`architecture overview <arch_overview_cluster_manager>`. |
|
|
|
.. code-block:: json |
|
|
|
{ |
|
"clusters": [], |
|
"sds": "{...}", |
|
"local_cluster_name": "...", |
|
"outlier_detection": "{...}", |
|
"cds": "{...}" |
|
} |
|
|
|
.. _config_cluster_manager_clusters: |
|
|
|
:ref:`clusters <config_cluster_manager_cluster>` |
|
*(required, array)* A list of upstream clusters that the cluster manager performs |
|
:ref:`service discovery <arch_overview_service_discovery>`, |
|
:ref:`health checking <arch_overview_health_checking>`, and |
|
:ref:`load balancing <arch_overview_load_balancing>` on. |
|
|
|
:ref:`sds <config_cluster_manager_sds>` |
|
*(sometimes required, object)* If any defined clusters use the :ref:`sds |
|
<arch_overview_service_discovery_sds>` cluster type, a global SDS configuration must be specified. |
|
|
|
.. _config_cluster_manager_local_cluster_name: |
|
|
|
local_cluster_name |
|
*(optional, string)* Name of the local cluster (i.e., the cluster that owns the Envoy running this |
|
configuration). In order to enable |
|
:ref:`zone aware routing <arch_overview_load_balancing_zone_aware_routing>` this option must be |
|
set. If *local_cluster_name* is defined then :ref:`clusters <config_cluster_manager_clusters>` |
|
must contain a definition of a cluster with the same name. |
|
|
|
:ref:`outlier_detection <config_cluster_manager_outlier_detection>` |
|
*(optional, object)* Optional global configuration for outlier detection. |
|
|
|
:ref:`cds <config_cluster_manager_cds>` |
|
*(optional, object)* Optional configuration for the cluster discovery service (CDS) API. |
|
|
|
Statistics |
|
---------- |
|
|
|
The cluster manager has a statistics tree rooted at *cluster_manager.* with the following |
|
statistics. Any ``:`` character in the stats name is replaced with ``_``. |
|
|
|
.. csv-table:: |
|
:header: Name, Type, Description |
|
:widths: 1, 1, 2 |
|
|
|
cluster_added, Counter, Total clusters added (either via static config or CDS) |
|
cluster_modified, Counter, Total clusters modified (via CDS) |
|
cluster_removed, Counter, Total clusters removed (via CDS) |
|
total_clusters, Gauge, Number of currently loaded clusters
|
|
|