carto
/
grpc


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>GRPC C++: xDS Features in gRPC</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">GRPC C++
   &#160;<span id="projectnumber">1.36.1</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="PageDoc"><div class="header">
  <div class="headertitle">
<div class="title">xDS Features in gRPC </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This document lists the <a href="https://github.com/envoyproxy/data-plane-api/tree/master/envoy/api/v2">xDS</a> features supported in various gRPC language implementations and versions.</p>
<p>Note that a gRPC client will simply ignore the configuration of a feature it does not support. The gRPC client does not generate a log to indicate that some configuration was ignored. It is impractical to generate a log and keep it up-to-date because xDS has a large number of APIs that gRPC does not support and the APIs keep evolving too. We recommend reading the <a href="https://github.com/grpc/proposal/blob/master/A27-xds-global-load-balancing.md">first gRFC</a> on xDS support in gRPC to understand the design philosophy.</p>
<p>The EDS policy will <em>not</em> support <a href="https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/load_balancing/overprovisioning">overprovisioning</a>, which is different from Envoy. Envoy takes the overprovisioning into account in both <a href="https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/load_balancing/locality_weight">locality-weighted load balancing</a> and <a href="https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/upstream/load_balancing/priority">priority failover</a>, but gRPC assumes that the xDS server will update it to redirect traffic when this kind of graceful failover is needed. gRPC will send the <a href="https://github.com/envoyproxy/envoy/pull/10136"><code>envoy.lb.does_not_support_overprovisioning</code> client feature</a> to the xDS server to tell the xDS server that it will not perform graceful failover; xDS server implementations may use this to decide whether to perform graceful failover themselves.</p>
<p>The EDS policy will not support per-endpoint stats; it will report only per-locality stats.</p>
<p>An <a href="https://github.com/envoyproxy/envoy/blob/12a4bc430eaf440ceb0d11286cfbd4c16b79cdd1/api/envoy/api/v2/endpoint/endpoint_components.proto#L72"><code>lb_endpoint</code></a> is ignored if the <code>health_status</code> is not HEALTHY or UNKNOWN. The optional <code>load_balancing_weight</code> is always ignored.</p>
<p>Initially, only <code>google_default</code> channel creds will be supported to authenticate with the xDS server.</p>
<p>The gRPC language implementations not listed in the table below do not support xDS features.</p>
<table class="markdownTable">
<tr class="markdownTableHead">
<th class="markdownTableHeadNone">Features </th><th class="markdownTableHeadNone">gRFCs </th><th class="markdownTableHeadNone"><a href="https://github.com/grpc/grpc/releases">C++, Python, Ruby, PHP</a> </th><th class="markdownTableHeadNone"><a href="https://github.com/grpc/grpc-java/releases">Java</a> </th><th class="markdownTableHeadNone"><a href="https://github.com/grpc/grpc-go/releases">Go</a> </th><th class="markdownTableHeadNone"><a href="https://github.com/grpc/grpc-node/releases">Node</a>  </th></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone"><b>xDS Infrastructure in gRPC client channel:</b><ul>
<li>
LDS-&gt;RDS-&gt;CDS-&gt;EDS flow</li>
<li>
ADS stream</li>
</ul>
</td><td class="markdownTableBodyNone"><a href="https://github.com/grpc/proposal/blob/master/A27-xds-global-load-balancing.md">A27</a> </td><td class="markdownTableBodyNone">v1.30.0 </td><td class="markdownTableBodyNone">v1.30.0 </td><td class="markdownTableBodyNone">v1.30.0 </td><td class="markdownTableBodyNone">v1.2.0  </td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone"><b>Load Balancing:</b><ul>
<li>
<a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/route/route_components.proto#route-virtualhost">Virtual host</a> domains matching</li>
<li>
Only default path ("" or "/") matching</li>
<li>
Priority-based weighted round-robin locality picking</li>
<li>
Round-robin endpoint picking within locality</li>
<li>
<a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/route/route_components.proto#envoy-api-msg-route-routeaction">Cluster</a> route action</li>
<li>
Client-side Load reporting via <a href="https://github.com/envoyproxy/data-plane-api/blob/master/envoy/service/load_stats/v2/lrs.proto">LRS</a></li>
</ul>
</td><td class="markdownTableBodyNone"><a href="https://github.com/grpc/proposal/blob/master/A27-xds-global-load-balancing.md">A27</a> </td><td class="markdownTableBodyNone">v1.30.0 </td><td class="markdownTableBodyNone">v1.30.0 </td><td class="markdownTableBodyNone">v1.30.0 </td><td class="markdownTableBodyNone">v1.2.0  </td></tr>
<tr class="markdownTableRowOdd">
<td class="markdownTableBodyNone">Request matching based on:<ul>
<li>
<a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/route/route_components.proto#route-routematch">Path</a> (prefix, full path and safe regex)<ul>
<li>
<a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/route/route_components.proto#route-routematch">case_sensitive</a> must be true else config is NACKed</li>
</ul>
</li>
<li>
<a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/route/route_components.proto#route-headermatcher">Headers</a></li>
</ul>
Request routing to multiple clusters based on <a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/route/route_components.proto#route-weightedcluster">weights</a> </td><td class="markdownTableBodyNone"><a href="https://github.com/grpc/proposal/blob/master/A28-xds-traffic-splitting-and-routing.md">A28</a> </td><td class="markdownTableBodyNone">v1.31.0 </td><td class="markdownTableBodyNone">v1.31.0 </td><td class="markdownTableBodyNone">v1.31.0 </td><td class="markdownTableBodyNone"></td></tr>
<tr class="markdownTableRowEven">
<td class="markdownTableBodyNone">Case insensitive prefix/full path matching:<ul>
<li>
<a href="https://www.envoyproxy.io/docs/envoy/latest/api-v2/api/v2/route/route_components.proto#route-routematch">case_sensitive</a> can be true or false</li>
</ul>
</td><td class="markdownTableBodyNone"></td><td class="markdownTableBodyNone">v1.34.0 </td><td class="markdownTableBodyNone">v1.34.0 </td><td class="markdownTableBodyNone">v1.34.0 </td><td class="markdownTableBodyNone"></td></tr>
</table>
</div></div><!-- contents -->
</div><!-- PageDoc -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 3 2021 19:17:23 for GRPC C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>