SpringCloud/spring-cloud-consul
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Sync docs from master to gh-pages

Browse Source
This commit is contained in:
buildmaster
2020-04-09 20:23:23 +00:00
parent 6f78866355
commit 3666c11884
2 changed files with 114 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
reference/html/spring-cloud-consul.html
View File

@@ -127,7 +127,12 @@ $(globalSwitch);
</li>
<li><a href="#http-health-check">3.3. HTTP Health Check</a>
<ul class="sectlevel3">
<li><a href="#metadata-and-consul-tags">3.3.1. Metadata and Consul tags</a></li>
<li><a href="#metadata-and-consul-tags">3.3.1. Metadata and Consul tags</a>
<ul class="sectlevel4">
<li><a href="#generated-metadata">Generated Metadata</a></li>
<li><a href="#official-consul-metadata">Official Consul Metadata</a></li>
</ul>
</li>
<li><a href="#making-the-consul-instance-id-unique">3.3.2. Making the Consul Instance ID Unique</a></li>
<li><a href="#applying-headers-to-health-check-requests">3.3.3. Applying Headers to Health Check Requests</a></li>
</ul>
@@ -424,6 +429,57 @@ spring.cloud.consul.discovery.management-tags</pre>
<div class="paragraph">
<p>The above configuration will result in a map with <code>foo&#8594;bar</code> and <code>baz&#8594;baz</code>.</p>
</div>
<div class="sect4">
<h5 id="generated-metadata"><a class="anchor" href="#generated-metadata"></a><a class="link" href="#generated-metadata">Generated Metadata</a></h5>
<div class="paragraph">
<p>The Consul Auto Registration will generate a few entries automatically.</p>
</div>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 1. Auto Generated Metadata</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Key</th>
<th class="tableblock halign-left valign-top">Value</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">'group'</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Property <code>spring.cloud.consul.discovery.instance-group</code>. This values is only generated if <code>instance-group</code> is not empty.'</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">'secure'</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">True if property <code>spring.cloud.consul.discovery.scheme</code> equals 'https', otherwise false.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">Property <code>spring.cloud.consul.discovery.default-zone-metadata-name</code>, defaults to 'zone'</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Property <code>spring.cloud.consul.discovery.instance-zone</code>. This values is only generated if <code>instance-zone</code> is not empty.'</p></td>
</tr>
</tbody>
</table>
</div>
<div class="sect4">
<h5 id="official-consul-metadata"><a class="anchor" href="#official-consul-metadata"></a><a class="link" href="#official-consul-metadata">Official Consul Metadata</a></h5>
<div class="paragraph">
<p>Consul added official support for a <code>meta</code> field that is a <code>Map&lt;String, String&gt;</code>. Spring Cloud Consul has added <code>spring.cloud.consul.discovery.metadata</code> and <code>spring.cloud.consul.discovery.management-metadata</code> properties to support it.</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<i class="fa icon-note" title="Note"></i>
</td>
<td class="content">
By default, the <code>ServiceInstance.getMetadata()</code> method from Spring Cloud Commons will continue to populated by parsing the <code>spring.cloud.consul.discovery.tags</code> property for backwards compatibility. To change this behaviour set <code>spring.cloud.consul.discovery.tags-as-metadata=false</code> and the metadata will be populated from <code>spring.cloud.consul.discovery.metadata</code>. In a future version, parsing the <code>tags</code> property will be removed.
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="sect3">
<h4 id="making-the-consul-instance-id-unique"><a class="anchor" href="#making-the-consul-instance-id-unique"></a><a class="link" href="#making-the-consul-instance-id-unique">3.3.2. Making the Consul Instance ID Unique</a></h4>