Skip to content

Commit

Permalink
Generate en docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Milvus-doc-bot authored and Milvus-doc-bot committed Sep 19, 2024
1 parent 831a2fa commit 9df54a3
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 14 deletions.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"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":"Deploy a Milvus Cluster on OpenShift","anchorList":[{"label":"Deploy a Milvus Cluster on OpenShift","href":"Deploy-a-Milvus-Cluster-on-OpenShift","type":1,"isActive":false},{"label":"Prerequisites","href":"Prerequisites","type":2,"isActive":false},{"label":"Step 1: Install Cert Manager","href":"Step-1-Install-Cert-Manager","type":2,"isActive":false},{"label":"Step 2: Issue a Self-Signed Certificate for Milvus Operator","href":"Step-2-Issue-a-Self-Signed-Certificate-for-Milvus-Operator","type":2,"isActive":false},{"label":"Step 3: Install Milvus Operator","href":"Step-3-Install-Milvus-Operator","type":2,"isActive":false},{"label":"Step 4: Deploy Milvus","href":"Step-4-Deploy-Milvus","type":2,"isActive":false},{"label":"What's Next","href":"Whats-Next","type":2,"isActive":false}]}
{"codeList":["# milvus-operator-certificate.yaml\napiVersion: cert-manager.io/v1\nkind: Certificate\nmetadata:\n name: milvus-operator-serving-cert\n namespace: milvus-operator\nspec:\n dnsNames:\n - milvus-operator-webhook-service.milvus-operator.svc\n - milvus-operator-webhook-service.milvus-operator.svc.cluster.local\n issuerRef:\n kind: Issuer\n name: milvus-operator-selfsigned-issuer\n secretName: milvus-operator-webhook-cert\n---\napiVersion: cert-manager.io/v1\nkind: Issuer\nmetadata:\n name: milvus-operator-selfsigned-issuer\n namespace: milvus-operator\nspec:\n selfSigned: {}\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":"Deploy a Milvus Cluster on OpenShift","anchorList":[{"label":"Deploy a Milvus Cluster on OpenShift","href":"Deploy-a-Milvus-Cluster-on-OpenShift","type":1,"isActive":false},{"label":"Prerequisites","href":"Prerequisites","type":2,"isActive":false},{"label":"Step 1: Install Cert Manager","href":"Step-1-Install-Cert-Manager","type":2,"isActive":false},{"label":"Step 2: Issue a Self-Signed Certificate for Milvus Operator","href":"Step-2-Issue-a-Self-Signed-Certificate-for-Milvus-Operator","type":2,"isActive":false},{"label":"Step 3: Install Milvus Operator","href":"Step-3-Install-Milvus-Operator","type":2,"isActive":false},{"label":"Step 4: Deploy Milvus","href":"Step-4-Deploy-Milvus","type":2,"isActive":false},{"label":"What's Next","href":"Whats-Next","type":2,"isActive":false}]}
Original file line number Diff line number Diff line change
Expand Up @@ -100,24 +100,24 @@ summary: Learn how to deploy a Milvus cluster on OpenShift.
apiVersion: cert-manager.io/v1
kind: Certificate
metadata:
name: milvus-operator-serving-cert
namespace: milvus-operator
name: milvus-operator-serving-cert
namespace: milvus-operator
spec:
dnsNames:
- milvus-operator-webhook-service.milvus-operator.svc
- milvus-operator-webhook-service.milvus-operator.svc.cluster.local
issuerRef:
dnsNames:
- milvus-operator-webhook-service.milvus-operator.svc
- milvus-operator-webhook-service.milvus-operator.svc.cluster.local
issuerRef:
kind: Issuer
name: milvus-operator-selfsigned-issuer
secretName: milvus-operator-webhook-cert
secretName: milvus-operator-webhook-cert
---
apiVersion: cert-manager.io/v1
kind: Issuer
metadata:
name: milvus-operator-selfsigned-issuer
namespace: milvus-operator
name: milvus-operator-selfsigned-issuer
namespace: milvus-operator
spec:
selfSigned: {}
selfSigned: {}
<button class="copy-code-btn"></button></code></pre></li>
<li><p>Apply the file:</p>
<pre><code translate="no" class="language-shell">kubectl apply -f milvus-<span class="hljs-keyword">operator</span>-certificate.yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ title: With Iterators
d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"
></path>
</svg>
</button></h1><p>Milvus provides search and query iterators for iterating results with a large volume of entities. Since Milvus limits TopK to 16384, users can use iterators to return large numbers or even whole entities in a collection in batch mode.</p>
</button></h1><p>Milvus provides search and query iterators for iterating through a large volume of entities. Since Milvus limits TopK to 16384, users can use iterators to return large numbers or even whole entities in a collection in batch mode.</p>
<h2 id="Overview" class="common-anchor-header">Overview<button data-href="#Overview" class="anchor-icon" translate="no">
<svg translate="no"
aria-hidden="true"
Expand All @@ -37,7 +37,7 @@ title: With Iterators
d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"
></path>
</svg>
</button></h2><p>Iterators are powerful tools that help you iterate through a large volume of or all data within a collection using primary key values and Boolean expressions. This can significantly improve the way you retrieve data. Unlike the traditional use of <strong>offset</strong> and <strong>limit</strong> parameters, which may become less efficient over time, iterators offer a more scalable solution.</p>
</button></h2><p>Iterators are efficient tool for scanning a whole collection or iterating through a large volume of entities by specifying primary key values or a filter expression. Compared to a search or query call with <strong>offset</strong> and <strong>limit</strong> parameters, using iterators is more efficient and scalable.</p>
<h3 id="Benefits-of-using-iterators" class="common-anchor-header">Benefits of using iterators</h3><ul>
<li><p><strong>Simplicity</strong>: Eliminates the complex <strong>offset</strong> and <strong>limit</strong> settings.</p></li>
<li><p><strong>Efficiency</strong>: Provides scalable data retrieval by fetching only the data in need.</p></li>
Expand All @@ -64,7 +64,7 @@ title: With Iterators
d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"
></path>
</svg>
</button></h2><p>The following steps repurpose the code to connect to Milvus, quickly set up a collection, and insert over 10,000 randomly generated entities into the collection.</p>
</button></h2><p>The following preparation step connects to Milvus and inserts randomly generated entities into a collection.</p>
<h3 id="Step-1-Create-a-collection" class="common-anchor-header">Step 1: Create a collection</h3><div class="language-python">
<p>Use <a href="https://milvus.io/api-reference/pymilvus/v2.4.x/MilvusClient/Client/MilvusClient.md"><code translate="no">MilvusClient</code></a> to connect to the Milvus server and <a href="https://milvus.io/api-reference/pymilvus/v2.4.x/MilvusClient/Collections/create_collection.md"><code translate="no">create_collection()</code></a> to create a collection.</p>
</div>
Expand Down

0 comments on commit 9df54a3

Please sign in to comment.