Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: auto generated #2597

Open
wants to merge 1 commit into
base: v2.4.x
Choose a base branch
from
Open

WIP: auto generated #2597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
583 changes: 564 additions & 19 deletions site/en/reference/sys_config/configure_common.md
View file
Open in desktop

Large diffs are not rendered by default.

900 changes: 794 additions & 106 deletions site/en/reference/sys_config/configure_datacoord.md
View file
Open in desktop

Large diffs are not rendered by default.

553 changes: 506 additions & 47 deletions site/en/reference/sys_config/configure_datanode.md
View file
Open in desktop

Large diffs are not rendered by default.

287 changes: 260 additions & 27 deletions site/en/reference/sys_config/configure_etcd.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,11 @@ id: configure_etcd.md
related_key: configure
group: system_configuration.md
summary: Learn how to configure etcd for Milvus.
title: etcd-related Configurations
---

# etcd-related Configurations

This topic introduces the etcd-related configurations of Milvus. etcd is the metadata engine supporting Milvus' metadata storage and access.

In this section, you can configure etcd endpoints, relevant key prefixes, etc.

<div class="alert note">
To share an etcd instance among multiple Milvus instances, you need to change <code>etcd.rootPath</code> to a unique value for each of the Milvus instances. For details, refer to <a href="operational_faq.md#Can-I-share-an-etcd-instance-among-multiple-Milvus-instances">Operation FAQs</a>.
</div>
Related configuration of etcd, used to store Milvus metadata & service discovery.

## `etcd.endpoints`

Expand All @@ -27,11 +20,7 @@ To share an etcd instance among multiple Milvus instances, you need to change <c
</thead>
<tbody>
<tr>
<td>
<li>Endpoints used to access etcd service. You can change this parameter as the endpoints of your own etcd cluster.</li>
<li>Environment variable: <code>ETCD_ENDPOINTS</code></li>
<li>etcd preferentially acquires valid address from environment variable <code>ETCD_ENDPOINTS</code> when Milvus is started.</li>
</td>
<td></td>
<td>localhost:2379</td>
</tr>
</tbody>
Expand All @@ -50,17 +39,13 @@ To share an etcd instance among multiple Milvus instances, you need to change <c
<tbody>
<tr>
<td>
<li>Root prefix of the key to where Milvus stores data in etcd.</li>
<li>It is recommended to change this parameter before starting Milvus for the first time.</li>
<li>To share an etcd instance among multiple Milvus instances, consider changing this to a different value for each Milvus instance before you start them. For details, see <a href="operational_faq.md#Can-I-share-an-etcd-instance-among-multiple-Milvus-instances">Operation FAQs</a>.</li>
<li>Set an easy-to-identify root path for Milvus if etcd service already exists.</li>
<li>Changing this for an already running Milvus instance may result in failures to read legacy data.</li>
</td>
<li>The root path where data is stored in etcd</li> </td>
<td>by-dev</td>
</tr>
</tbody>
</table>


## `etcd.metaSubPath`

<table id="etcd.metaSubPath">
Expand All @@ -73,10 +58,7 @@ To share an etcd instance among multiple Milvus instances, you need to change <c
<tbody>
<tr>
<td>
<li>Sub-prefix of the key to where Milvus stores metadata-related information in etcd.</li>
<li>Caution: Changing this parameter after using Milvus for a period of time will affect your access to old data.</li>
<li>It is recommended to change this parameter before starting Milvus for the first time.</li>
</td>
<li>metaRootPath = rootPath + '/' + metaSubPath</li> </td>
<td>meta</td>
</tr>
</tbody>
Expand All @@ -95,13 +77,264 @@ To share an etcd instance among multiple Milvus instances, you need to change <c
<tbody>
<tr>
<td>
<li>Sub-prefix of the key to where Milvus stores timestamps in etcd.</li>
<li>Caution: Changing this parameter after using Milvus for a period of time will affect your access to old data.</li>
<li>It is recommended not to change this parameter if there is no specific reason.</li>
</td>
<li>kvRootPath = rootPath + '/' + kvSubPath</li> </td>
<td>kv</td>
</tr>
</tbody>
</table>


## `etcd.log.level`

<table id="etcd.log.level">
<thead>
<tr>
<th class="width80">Description</th>
<th class="width20">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<li>Only supports debug, info, warn, error, panic, or fatal. Default 'info'.</li> </td>
<td>info</td>
</tr>
</tbody>
</table>


## `etcd.log.path`

<table id="etcd.log.path">
<thead>
<tr>
<th class="width80">Description</th>
<th class="width20">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<li>path is one of:</li>
<li> - "default" as os.Stderr,</li>
<li> - "stderr" as os.Stderr,</li>
<li> - "stdout" as os.Stdout,</li>
<li> - file path to append server logs to.</li>
<li>please adjust in embedded Milvus: /tmp/milvus/logs/etcd.log</li> </td>
<td>stdout</td>
</tr>
</tbody>
</table>


## `etcd.ssl.enabled`

<table id="etcd.ssl.enabled">
<thead>
<tr>
<th class="width80">Description</th>
<th class="width20">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<li>Whether to support ETCD secure connection mode</li> </td>
<td>false</td>
</tr>
</tbody>
</table>


## `etcd.ssl.tlsCert`

<table id="etcd.ssl.tlsCert">
<thead>
<tr>
<th class="width80">Description</th>
<th class="width20">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<li>path to your cert file</li> </td>
<td>/path/to/etcd-client.pem</td>
</tr>
</tbody>
</table>


## `etcd.ssl.tlsKey`

<table id="etcd.ssl.tlsKey">
<thead>
<tr>
<th class="width80">Description</th>
<th class="width20">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<li>path to your key file</li> </td>
<td>/path/to/etcd-client-key.pem</td>
</tr>
</tbody>
</table>


## `etcd.ssl.tlsCACert`

<table id="etcd.ssl.tlsCACert">
<thead>
<tr>
<th class="width80">Description</th>
<th class="width20">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<li>path to your CACert file</li> </td>
<td>/path/to/ca.pem</td>
</tr>
</tbody>
</table>


## `etcd.ssl.tlsMinVersion`

<table id="etcd.ssl.tlsMinVersion">
<thead>
<tr>
<th class="width80">Description</th>
<th class="width20">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<li>TLS min version</li>
<li>Optional values: 1.0, 1.1, 1.2, 1.3。</li>
<li>We recommend using version 1.2 and above.</li> </td>
<td>1.3</td>
</tr>
</tbody>
</table>


## `etcd.requestTimeout`

<table id="etcd.requestTimeout">
<thead>
<tr>
<th class="width80">Description</th>
<th class="width20">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<li>Etcd operation timeout in milliseconds</li> </td>
<td>10000</td>
</tr>
</tbody>
</table>


## `etcd.use.embed`

<table id="etcd.use.embed">
<thead>
<tr>
<th class="width80">Description</th>
<th class="width20">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<li>Whether to enable embedded Etcd (an in-process EtcdServer).</li> </td>
<td>false</td>
</tr>
</tbody>
</table>


## `etcd.data.dir`

<table id="etcd.data.dir">
<thead>
<tr>
<th class="width80">Description</th>
<th class="width20">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<li>Embedded Etcd only. please adjust in embedded Milvus: /tmp/milvus/etcdData/</li> </td>
<td>default.etcd</td>
</tr>
</tbody>
</table>


## `etcd.auth.enabled`

<table id="etcd.auth.enabled">
<thead>
<tr>
<th class="width80">Description</th>
<th class="width20">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<li>Whether to enable authentication</li> </td>
<td>false</td>
</tr>
</tbody>
</table>


## `etcd.auth.userName`

<table id="etcd.auth.userName">
<thead>
<tr>
<th class="width80">Description</th>
<th class="width20">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<li>username for etcd authentication</li> </td>
<td></td>
</tr>
</tbody>
</table>


## `etcd.auth.password`

<table id="etcd.auth.password">
<thead>
<tr>
<th class="width80">Description</th>
<th class="width20">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<li>password for etcd authentication</li> </td>
<td></td>
</tr>
</tbody>
</table>


59 changes: 59 additions & 0 deletions site/en/reference/sys_config/configure_gpu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
id: configure_gpu.md
related_key: configure
group: system_configuration.md
summary: Learn how to configure gpu for Milvus.
---

# gpu-related Configurations

#when using GPU indexing, Milvus will utilize a memory pool to avoid frequent memory allocation and deallocation.

#here, you can set the size of the memory occupied by the memory pool, with the unit being MB.

#note that there is a possibility of Milvus crashing when the actual memory demand exceeds the value set by maxMemSize.

#if initMemSize and MaxMemSize both set zero,

#milvus will automatically initialize half of the available GPU memory,

#maxMemSize will the whole available GPU memory.

## `gpu.initMemSize`

<table id="gpu.initMemSize">
<thead>
<tr>
<th class="width80">Description</th>
<th class="width20">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<li>Gpu Memory Pool init size</li> </td>
<td></td>
</tr>
</tbody>
</table>


## `gpu.maxMemSize`

<table id="gpu.maxMemSize">
<thead>
<tr>
<th class="width80">Description</th>
<th class="width20">Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<li>Gpu Memory Pool Max size</li> </td>
<td></td>
</tr>
</tbody>
</table>


Loading
Loading