Skip to content

Commit

Permalink
Merge pull request #927 from milvus-io/fix/docs-cn
Browse files Browse the repository at this point in the history
fix: update zh docs
  • Loading branch information
ThyeeZz authored Sep 3, 2024
2 parents baf7995 + 544c0bb commit 2de416c
Show file tree
Hide file tree
Showing 34 changed files with 1,649 additions and 1,521 deletions.
2 changes: 1 addition & 1 deletion localization/v2.4.x/site/zh/about/comparison.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"codeList":[],"headingContent":"","anchorList":[{"label":"Comparing Milvus with Alternatives","href":"Comparing-Milvus-with-Alternatives","type":1,"isActive":false},{"label":"Milvus highlights","href":"Milvus-highlights","type":2,"isActive":false},{"label":"Overall comparison","href":"Overall-comparison","type":2,"isActive":false},{"label":"Terminology comparison","href":"Terminology-comparison","type":2,"isActive":false},{"label":"Capability comparison","href":"Capability-comparison","type":2,"isActive":false},{"label":"What's next","href":"Whats-next","type":2,"isActive":false}]}
{"codeList":[],"headingContent":"","anchorList":[{"label":" Milvus 与其他向量数据库进行比较","href":"Comparing-Milvus-with-Alternatives","type":1,"isActive":false},{"label":"Milvus 的亮点","href":"Milvus-highlights","type":2,"isActive":false},{"label":"整体比较","href":"Overall-comparison","type":2,"isActive":false},{"label":"术语比较","href":"Terminology-comparison","type":2,"isActive":false},{"label":"能力比较","href":"Capability-comparison","type":2,"isActive":false},{"label":"下一步","href":"Whats-next","type":2,"isActive":false}]}
8 changes: 4 additions & 4 deletions localization/v2.4.x/site/zh/about/comparison.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ summary: 本文将 Milvus 与其他向量搜索解决方案进行比较。
</button></h2><p>为了比较 Milvus 和 Pinecone 这两个向量数据库解决方案,下表列出了各种功能之间的差异。</p>
<table>
<thead>
<tr><th>特征</th><th>松果</th><th>Milvus</th><th>备注</th></tr>
<tr><th>特征</th><th>Pinecone</th><th>Milvus</th><th>备注</th></tr>
</thead>
<tbody>
<tr><td>部署模式</td><td>纯 SaaS</td><td>Milvus Lite、内部独立和集群、Zilliz 云 Saas 和 BYOC</td><td>Milvus 提供更灵活的部署模式。</td></tr>
Expand Down Expand Up @@ -89,10 +89,10 @@ summary: 本文将 Milvus 与其他向量搜索解决方案进行比较。
</button></h2><p>虽然 Milvus 和 Pinecone 都具有类似的向量数据库功能,但两者在特定领域的术语略有不同。详细的术语比较如下。</p>
<table>
<thead>
<tr><th>松果</th><th>Milvus</th><th>备注</th></tr>
<tr><th>Pinecone</th><th>Milvus</th><th>备注</th></tr>
</thead>
<tbody>
<tr><td>索引</td><td><a href="https://zilliz.com/comparison">收集</a></td><td>在 Pinecone 中,索引是存储和管理相同大小向量的组织单位,索引与硬件(称为 pod)紧密结合。相比之下,Milvus 集合的作用类似,但能在单个实例中处理多个集合。</td></tr>
<tr><td>索引</td><td><a href="https://zilliz.com/comparison">Collection</a></td><td>在 Pinecone 中,索引是存储和管理相同大小向量的组织单位,索引与硬件(称为 pod)紧密结合。相比之下,Milvus 集合的作用类似,但能在单个实例中处理多个集合。</td></tr>
<tr><td>集合</td><td><a href="https://milvus.io/docs/milvus_backup_overview.md#Milvus-Backup">备份</a></td><td>在 Pinecone 中,集合本质上是索引的静态快照,主要用于备份目的,不能被查询。在 Milvus 中,用于创建备份的等效功能更加透明,名称也更直观。</td></tr>
<tr><td>命名空间</td><td><a href="https://milvus.io/docs/use-partition-key.md#Use-Partition-Key">分区键</a></td><td>命名空间允许将索引中的向量分割成子集。Milvus 提供了多种方法,如分区或分区键,以确保集合内数据的有效隔离。</td></tr>
<tr><td>元数据</td><td><a href="https://milvus.io/docs/boolean.md">标量字段</a></td><td>Pinecone 的元数据处理依赖于键值对,而 Milvus 允许使用复杂的标量字段,包括标准数据类型和动态 JSON 字段。</td></tr>
Expand All @@ -117,7 +117,7 @@ summary: 本文将 Milvus 与其他向量搜索解决方案进行比较。
</svg>
</button></h2><table>
<thead>
<tr><th>功能</th><th>松果</th><th>Milvus</th></tr>
<tr><th>功能</th><th>Pinecone</th><th>Milvus</th></tr>
</thead>
<tbody>
<tr><td>部署模式</td><td>纯 SaaS</td><td>Milvus Lite、内部独立和集群、Zilliz 云 Saas 和 BYOC</td></tr>
Expand Down
2 changes: 1 addition & 1 deletion localization/v2.4.x/site/zh/about/milvus_adopters.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"codeList":[],"headingContent":"","anchorList":[{"label":"Milvus Adopters","href":"Milvus-Adopters","type":1,"isActive":false}]}
{"codeList":[],"headingContent":"","anchorList":[{"label":"Milvus 采用者","href":"Milvus-Adopters","type":1,"isActive":false}]}
2 changes: 1 addition & 1 deletion localization/v2.4.x/site/zh/about/roadmap.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"codeList":[],"headingContent":"","anchorList":[{"label":"Milvus Roadmap","href":"Milvus-Roadmap","type":1,"isActive":false},{"label":"Roadmap","href":"Roadmap","type":2,"isActive":false},{"label":"How to contribute","href":"How-to-contribute","type":2,"isActive":false}]}
{"codeList":[],"headingContent":"","anchorList":[{"label":"Milvus 路线图","href":"Milvus-Roadmap","type":1,"isActive":false},{"label":"路线图","href":"Roadmap","type":2,"isActive":false},{"label":"如何贡献","href":"How-to-contribute","type":2,"isActive":false}]}
24 changes: 15 additions & 9 deletions localization/v2.4.x/site/zh/adminGuide/authenticate.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ id: authenticate.md
summary: 了解如何在 Milvus 中管理用户身份验证。
title: 验证用户访问
---

<h1 id="Authenticate-User-Access" class="common-anchor-header">验证用户访问<button data-href="#Authenticate-User-Access" class="anchor-icon" translate="no">
<svg translate="no"
aria-hidden="true"
Expand Down Expand Up @@ -41,7 +42,7 @@ title: 验证用户访问
></path>
</svg>
</button></h2><div class="filter">
<a href="#docker">Docker Compose</a> <a href="#helm">Helm</a> <a href="#operator">Milvus 操作员</a></div>
<a href="#docker">Docker Compose</a> <a href="#helm">Helm</a> <a href="#operator">Milvus Operator</a></div>
<div class="filter-docker">
<p>要为 Milvus 服务器启用用户身份验证,请在 Milvus 配置文件<code translate="no">milvus.yaml</code> 中将 common.security.authorizationEnabled 设为 true。有关配置的更多信息,请参阅<a href="https://milvus.io/docs/configure-docker.md?tab=component">使用 Docker Compose 配置 Milvus</a>。</p>
<pre><code translate="no" class="language-yaml">...
Expand Down Expand Up @@ -100,10 +101,11 @@ spec:
<span class="hljs-keyword">from</span> pymilvus <span class="hljs-keyword">import</span> MilvusClient

client = MilvusClient(
uri=<span class="hljs-string">&#x27;http://localhost:19530&#x27;</span>, <span class="hljs-comment"># replace with your own Milvus server address</span>
token=<span class="hljs-string">&quot;root:Milvus&quot;</span>
)
uri=<span class="hljs-string">&#x27;http://localhost:19530&#x27;</span>, <span class="hljs-comment"># replace with your own Milvus server address</span>
token=<span class="hljs-string">&quot;root:Milvus&quot;</span>
)
<button class="copy-code-btn"></button></code></pre>

<div class="alert note">
如果在启用身份验证的情况下连接 Milvus 时未能提供有效令牌,则会收到 gRPC 错误。</div>
<h2 id="Create-a-new-user" class="common-anchor-header">创建新用户<button data-href="#Create-a-new-user" class="anchor-icon" translate="no">
Expand Down Expand Up @@ -135,6 +137,7 @@ client.describe_user(<span class="hljs-string">&quot;user_1&quot;</span>)
<span class="hljs-comment"># output</span>
<span class="hljs-comment"># {&#x27;user_name&#x27;: &#x27;user_1&#x27;, &#x27;roles&#x27;: ()}</span>
<button class="copy-code-btn"></button></code></pre>

<p>有关创建用户的更多信息,请参阅<a href="https://milvus.io/api-reference/pymilvus/v2.4.x/MilvusClient/Authentication/create_user.md">create_user()</a>。</p>
<h2 id="Connect-to-Milvus-with-a-new-user" class="common-anchor-header">使用新用户连接 Milvus<button data-href="#Connect-to-Milvus-with-a-new-user" class="anchor-icon" translate="no">
<svg translate="no"
Expand All @@ -155,10 +158,11 @@ client.describe_user(<span class="hljs-string">&quot;user_1&quot;</span>)
<pre><code translate="no" class="language-python"><span class="hljs-comment"># connect to milvus with the newly created user</span>

client = MilvusClient(
uri=<span class="hljs-string">&quot;http://localhost:19530&quot;</span>,
token=<span class="hljs-string">&quot;user_1:P@ssw0rd&quot;</span>
uri=<span class="hljs-string">&quot;http://localhost:19530&quot;</span>,
token=<span class="hljs-string">&quot;user_1:P@ssw0rd&quot;</span>
)
<button class="copy-code-btn"></button></code></pre>

<h2 id="Update-user-password" class="common-anchor-header">更新用户密码<button data-href="#Update-user-password" class="anchor-icon" translate="no">
<svg translate="no"
aria-hidden="true"
Expand All @@ -178,11 +182,12 @@ client = MilvusClient(
<pre><code translate="no" class="language-python"><span class="hljs-comment"># update password</span>

client.update_password(
user_name=<span class="hljs-string">&quot;user_1&quot;</span>,
old_password=<span class="hljs-string">&quot;P@ssw0rd&quot;</span>,
new_password=<span class="hljs-string">&quot;P@ssw0rd123&quot;</span>
user_name=<span class="hljs-string">&quot;user_1&quot;</span>,
old_password=<span class="hljs-string">&quot;P@ssw0rd&quot;</span>,
new_password=<span class="hljs-string">&quot;P@ssw0rd123&quot;</span>
)
<button class="copy-code-btn"></button></code></pre>

<p>有关更新用户密码的更多信息,请参阅<a href="https://milvus.io/api-reference/pymilvus/v2.4.x/MilvusClient/Authentication/update_password.md">update_password()</a>。</p>
<p>如果忘记了旧密码,Milvus 提供了一个配置项,允许将某些用户指定为超级用户。这样,重置密码时就不需要旧密码了。</p>
<p>默认情况下,Milvus 配置文件中的<code translate="no">common.security.superUsers</code> 字段为空,这意味着所有用户在重置密码时都必须提供旧密码。不过,你可以将特定用户指定为超级用户,他们不需要提供旧密码。在下面的代码段中,<code translate="no">root</code> 和<code translate="no">foo</code> 被指定为超级用户。</p>
Expand Down Expand Up @@ -231,6 +236,7 @@ client.update_password(

client.list_users()
<button class="copy-code-btn"></button></code></pre>

<h2 id="Limitations" class="common-anchor-header">限制条件<button data-href="#Limitations" class="anchor-icon" translate="no">
<svg translate="no"
aria-hidden="true"
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1,53 @@
{"codeList":["# milvus-operator-certificate.yaml\napiVersion: cert-manager.io/v1\nkind: Certificate\nmetadata:\nname: milvus-operator-serving-cert\nnamespace: milvus-operator\nspec:\ndnsNames:\n- milvus-operator-webhook-service.milvus-operator.svc\n- milvus-operator-webhook-service.milvus-operator.svc.cluster.local\nissuerRef:\n kind: Issuer\n name: milvus-operator-selfsigned-issuer\nsecretName: milvus-operator-webhook-cert\n---\napiVersion: cert-manager.io/v1\nkind: Issuer\nmetadata:\nname: milvus-operator-selfsigned-issuer\nnamespace: milvus-operator\nspec:\nselfSigned: {}\n","kubectl apply -f milvus-operator-certificate.yaml\n","helm repo add milvus-operator https://zilliztech.github.io/milvus-operator/\nhelm repo update milvus-operator\n","helm -n milvus-operator upgrade --install --create-namespace milvus-operator milvus-operator/milvus-operator\n"],"headingContent":"","anchorList":[{"label":"在 OpenShift 上部署 Milvus 集群","href":"Deploy-a-Milvus-Cluster-on-OpenShift","type":1,"isActive":false},{"label":"先决条件","href":"Prerequisites","type":2,"isActive":false},{"label":"步骤 1:安装证书管理器","href":"Step-1-Install-Cert-Manager","type":2,"isActive":false},{"label":"步骤 2:为 Milvus 操作员签发自签名证书","href":"Step-2-Issue-a-Self-Signed-Certificate-for-Milvus-Operator","type":2,"isActive":false},{"label":"步骤 3:安装 Milvus 操作器","href":"Step-3-Install-Milvus-Operator","type":2,"isActive":false},{"label":"步骤 4:部署 Milvus","href":"Step-4-Deploy-Milvus","type":2,"isActive":false},{"label":"下一步行动","href":"Whats-Next","type":2,"isActive":false}]}
{
"codeList": [
"# milvus-operator-certificate.yaml\napiVersion: cert-manager.io/v1\nkind: Certificate\nmetadata:\nname: milvus-operator-serving-cert\nnamespace: milvus-operator\nspec:\ndnsNames:\n- milvus-operator-webhook-service.milvus-operator.svc\n- milvus-operator-webhook-service.milvus-operator.svc.cluster.local\nissuerRef:\n kind: Issuer\n name: milvus-operator-selfsigned-issuer\nsecretName: milvus-operator-webhook-cert\n---\napiVersion: cert-manager.io/v1\nkind: Issuer\nmetadata:\nname: milvus-operator-selfsigned-issuer\nnamespace: milvus-operator\nspec:\nselfSigned: {}\n",
"kubectl apply -f milvus-operator-certificate.yaml\n",
"helm repo add milvus-operator https://zilliztech.github.io/milvus-operator/\nhelm repo update milvus-operator\n",
"helm -n milvus-operator upgrade --install --create-namespace milvus-operator milvus-operator/milvus-operator\n"
],
"headingContent": "",
"anchorList": [
{
"label": "在 OpenShift 上部署 Milvus 集群",
"href": "Deploy-a-Milvus-Cluster-on-OpenShift",
"type": 1,
"isActive": false
},
{
"label": "先决条件",
"href": "Prerequisites",
"type": 2,
"isActive": false
},
{
"label": "步骤 1:安装证书管理器",
"href": "Step-1-Install-Cert-Manager",
"type": 2,
"isActive": false
},
{
"label": "步骤 2:为 Milvus Operator签发自签名证书",
"href": "Step-2-Issue-a-Self-Signed-Certificate-for-Milvus-Operator",
"type": 2,
"isActive": false
},
{
"label": "步骤 3:安装 Milvus 操作器",
"href": "Step-3-Install-Milvus-Operator",
"type": 2,
"isActive": false
},
{
"label": "步骤 4:部署 Milvus",
"href": "Step-4-Deploy-Milvus",
"type": 2,
"isActive": false
},
{
"label": "下一步行动",
"href": "Whats-Next",
"type": 2,
"isActive": false
}
]
}
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"codeList":["rootCoord:\n maxGeneralCapacity: 1024\n","60 (collections) x 2 (shards) x 4 (partitions) + 40 (collections) x 1 (shard) x 12 (partitions) = 960\n","failed checking constraint: sum_collections(parition*shard) exceeding the max general capacity:\n"],"headingContent":"","anchorList":[{"label":"限制收集次数","href":"Limit-Collection-Counts","type":1,"isActive":false},{"label":"配置选项","href":"Configuration-options","type":2,"isActive":false},{"label":"计算藏品数量","href":"Calculating-the-number-of-collections","type":2,"isActive":false}]}
{"codeList":["rootCoord:\n maxGeneralCapacity: 1024\n","60 (collections) x 2 (shards) x 4 (partitions) + 40 (collections) x 1 (shard) x 12 (partitions) = 960\n","failed checking constraint: sum_collections(parition*shard) exceeding the max general capacity:\n"],"headingContent":"","anchorList":[{"label":"限制 Collection 数","href":"Limit-Collection-Counts","type":1,"isActive":false},{"label":"配置选项","href":"Configuration-options","type":2,"isActive":false},{"label":"计算藏品数量","href":"Calculating-the-number-of-collections","type":2,"isActive":false}]}
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
id: limit_collection_counts.md
title: 设置收集数量限制
title: 设置 Collection 数量限制
summary: ''
---
<h1 id="Limit-Collection-Counts" class="common-anchor-header">限制收集数<button data-href="#Limit-Collection-Counts" class="anchor-icon" translate="no">
<h1 id="Limit-Collection-Counts" class="common-anchor-header">限制 Collection 数<button data-href="#Limit-Collection-Counts" class="anchor-icon" translate="no">
<svg translate="no"
aria-hidden="true"
focusable="false"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
id: message_storage_operator.md
title: 使用 Milvus Operator 配置信息存储
related_key: 'minio, s3, storage, etcd, pulsar'
related_key: "minio, s3, storage, etcd, pulsar"
summary: 了解如何使用 Milvus Operator 配置信息存储。
---
<h1 id="Configure-Message-Storage-with-Milvus-Operator" class="common-anchor-header">使用 Milvus 操作员配置消息存储<button data-href="#Configure-Message-Storage-with-Milvus-Operator" class="anchor-icon" translate="no">

<h1 id="Configure-Message-Storage-with-Milvus-Operator" class="common-anchor-header">使用 Milvus Operator 配置消息存储<button data-href="#Configure-Message-Storage-with-Milvus-Operator" class="anchor-icon" translate="no">
<svg translate="no"
aria-hidden="true"
focusable="false"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
id: meta_storage_operator.md
title: 使用 Milvus Operator 配置元存储
related_key: 'minio, s3, storage, etcd, pulsar'
related_key: "minio, s3, storage, etcd, pulsar"
summary: 了解如何使用 Milvus Operator 配置元存储。
---
<h1 id="Configure-Meta-Storage-with-Milvus-Operator" class="common-anchor-header">使用 Milvus 操作员配置元数据存储<button data-href="#Configure-Meta-Storage-with-Milvus-Operator" class="anchor-icon" translate="no">

<h1 id="Configure-Meta-Storage-with-Milvus-Operator" class="common-anchor-header">使用 Milvus Operator 配置元数据存储<button data-href="#Configure-Meta-Storage-with-Milvus-Operator" class="anchor-icon" translate="no">
<svg translate="no"
aria-hidden="true"
focusable="false"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
---
id: object_storage_operator.md
title: 使用 Milvus Operator 配置对象存储
related_key: 'minio, s3, storage, etcd, pulsar'
related_key: "minio, s3, storage, etcd, pulsar"
summary: 了解如何使用 Milvus Operator 配置对象存储。
---
<h1 id="Configure-Object-Storage-with-Milvus-Operator" class="common-anchor-header">使用 Milvus 操作员配置对象存储<button data-href="#Configure-Object-Storage-with-Milvus-Operator" class="anchor-icon" translate="no">

<h1 id="Configure-Object-Storage-with-Milvus-Operator" class="common-anchor-header">使用 Milvus Operator 配置对象存储<button data-href="#Configure-Object-Storage-with-Milvus-Operator" class="anchor-icon" translate="no">
<svg translate="no"
aria-hidden="true"
focusable="false"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@ id: upgrade_milvus_cluster-docker.md
summary: 了解如何使用 Docker Compose 升级 Milvus 集群。
title: 使用 Docker Compose 升级 Milvus 集群
---
<div class="tab-wrapper"><a href="/docs/zh/upgrade_milvus_standalone-operator.md" class=''>Milvus 操作员Milvus</a><a href="/docs/zh/upgrade_milvus_cluster-operator.md" class=''>操作员Milvus 操作员</a><a href="/docs/zh/configure-helm.md" class=''>HelmDocker</a><a href="/docs/zh/configure_operator.md" class=''></a><a href="/docs/zh/upgrade_milvus_standalone-helm.md" class=''>ComposeHelmDocker</a><a href="/docs/zh/configure-docker.md" class=''></a><a href="/docs/zh/upgrade_milvus_cluster-helm.md" class=''>ComposeHelm</a></div>

<div class="tab-wrapper"><a href="/docs/zh/upgrade_milvus_standalone-operator.md" class=''>Milvus OperatorMilvus</a><a href="/docs/zh/upgrade_milvus_cluster-operator.md" class=''>操作员Milvus Operator</a><a href="/docs/zh/configure-helm.md" class=''>HelmDocker</a><a href="/docs/zh/configure_operator.md" class=''></a><a href="/docs/zh/upgrade_milvus_standalone-helm.md" class=''>ComposeHelmDocker</a><a href="/docs/zh/configure-docker.md" class=''></a><a href="/docs/zh/upgrade_milvus_cluster-helm.md" class=''>ComposeHelm</a></div>
<h1 id="Upgrade-Milvus-Cluster-with-Docker-Compose" class="common-anchor-header">使用 Docker Compose 升级 Milvus 集群<button data-href="#Upgrade-Milvus-Cluster-with-Docker-Compose" class="anchor-icon" translate="no">
<svg translate="no"
aria-hidden="true"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"isActive": false
},
{
"label": "升级您的 Milvus 操作员",
"label": "升级您的 Milvus Operator",
"href": "Upgrade-your-Milvus-operator",
"type": 2,
"isActive": false
Expand Down
Loading

0 comments on commit 2de416c

Please sign in to comment.