Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zhanshuyou committed Nov 28, 2024
1 parent e8f3550 commit fb70e3d
Show file tree
Hide file tree
Showing 199 changed files with 6,190 additions and 1,559 deletions.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"codeList":["$ kubectl get sc\n\nNAME PROVISIONER RECLAIMPOLICY VOLUMEBIINDINGMODE ALLOWVOLUMEEXPANSION AGE\nstandard (default) k8s.io/minikube-hostpath Delete Immediate false \n","$ helm repo add milvus https://github.com/zilliztech/milvus-helm\n","helm repo add zilliztech https://github.com/zilliztech/milvus-helm\nhelm repo update\n# upgrade existing helm release\nhelm upgrade my-release zilliztech/milvus\n","$ helm repo update\n","$ helm install my-release milvus/milvus\n","$ kubectl get pods\n","NAME READY STATUS RESTARTS AGE\nmy-release-etcd-0 1/1 Running 0 3m23s\nmy-release-etcd-1 1/1 Running 0 3m23s\nmy-release-etcd-2 1/1 Running 0 3m23s\nmy-release-milvus-datanode-68cb87dcbd-4khpm 1/1 Running 0 3m23s\nmy-release-milvus-indexnode-5c5f7b5bd9-l8hjg 1/1 Running 0 3m24s\nmy-release-milvus-mixcoord-7fb9488465-dmbbj 1/1 Running 0 3m23s\nmy-release-milvus-proxy-6bd7f5587-ds2xv 1/1 Running 0 3m24s\nmy-release-milvus-querynode-5cd8fff495-k6gtg 1/1 Running 0 3m24s\nmy-release-minio-0 1/1 Running 0 3m23s\nmy-release-minio-1 1/1 Running 0 3m23s\nmy-release-minio-2 1/1 Running 0 3m23s\nmy-release-minio-3 1/1 Running 0 3m23s\nmy-release-pulsar-autorecovery-86f5dbdf77-lchpc 1/1 Running 0 3m24s\nmy-release-pulsar-bookkeeper-0 1/1 Running 0 3m23s\nmy-release-pulsar-bookkeeper-1 1/1 Running 0 98s\nmy-release-pulsar-broker-556ff89d4c-2m29m 1/1 Running 0 3m23s\nmy-release-pulsar-proxy-6fbd75db75-nhg4v 1/1 Running 0 3m23s\nmy-release-pulsar-zookeeper-0 1/1 Running 0 3m23s\nmy-release-pulsar-zookeeper-metadata-98zbr 0/1 Completed 0 3m24s\n","$ kubectl get pod my-release-milvus-proxy-6bd7f5587-ds2xv --template\n='{{(index (index .spec.containers 0).ports 0).containerPort}}{{\"\\n\"}}'\n19530\n","$ kubectl port-forward service/my-release-milvus 27017:19530\nForwarding from 127.0.0.1:27017 -> 19530\n","$ kubectl port-forward --address 0.0.0.0 service/my-release-milvus 27017:19530\nForwarding from 0.0.0.0:27017 -> 19530\n","$ helm template my-release milvus/milvus > milvus_manifest.yaml\n","$ wget https://raw.githubusercontent.com/milvus-io/milvus/master/deployments/offline/requirements.txt\n$ wget https://raw.githubusercontent.com/milvus-io/milvus/master/deployments/offline/save_image.py\n","$ pip3 install -r requirements.txt\n$ python3 save_image.py --manifest milvus_manifest.yaml\n","$ for image in $(find . -type f -name \"*.tar.gz\") ; do gunzip -c $image | docker load; done\n","$ kubectl apply -f milvus_manifest.yaml\n","$ helm repo update\n$ helm upgrade my-release zilliztech/milvus\n","$ helm uninstall my-release\n"],"headingContent":"Run Milvus in Kubernetes with Helm","anchorList":[{"label":"Milvus in Kubernetes mit Helm starten","href":"Run-Milvus-in-Kubernetes-with-Helm","type":1,"isActive":false},{"label":"Übersicht","href":"Overview","type":2,"isActive":false},{"label":"Voraussetzungen","href":"Prerequisites","type":2,"isActive":false},{"label":"Milvus Helm Chart installieren","href":"Install-Milvus-Helm-Chart","type":2,"isActive":false},{"label":"Online-Installation","href":"Online-install","type":2,"isActive":false},{"label":"Offline-Installation","href":"Offline-install","type":2,"isActive":false},{"label":"Upgrade des laufenden Milvus-Clusters","href":"Upgrade-running-Milvus-cluster","type":2,"isActive":false},{"label":"Milvus deinstallieren","href":"Uninstall-Milvus","type":2,"isActive":false},{"label":"Wie geht es weiter?","href":"Whats-next","type":2,"isActive":false}]}
{"codeList":["$ kubectl get sc\n\nNAME PROVISIONER RECLAIMPOLICY VOLUMEBIINDINGMODE ALLOWVOLUMEEXPANSION AGE\nstandard (default) k8s.io/minikube-hostpath Delete Immediate false \n","$ helm repo add milvus https://zilliztech.github.io/milvus-helm/\n","helm repo add zilliztech https://zilliztech.github.io/milvus-helm/\nhelm repo update\n# upgrade existing helm release\nhelm upgrade my-release zilliztech/milvus\n","$ helm repo update\n","$ helm install my-release milvus/milvus\n","$ kubectl get pods\n","NAME READY STATUS RESTARTS AGE\nmy-release-etcd-0 1/1 Running 0 3m23s\nmy-release-etcd-1 1/1 Running 0 3m23s\nmy-release-etcd-2 1/1 Running 0 3m23s\nmy-release-milvus-datanode-68cb87dcbd-4khpm 1/1 Running 0 3m23s\nmy-release-milvus-indexnode-5c5f7b5bd9-l8hjg 1/1 Running 0 3m24s\nmy-release-milvus-mixcoord-7fb9488465-dmbbj 1/1 Running 0 3m23s\nmy-release-milvus-proxy-6bd7f5587-ds2xv 1/1 Running 0 3m24s\nmy-release-milvus-querynode-5cd8fff495-k6gtg 1/1 Running 0 3m24s\nmy-release-minio-0 1/1 Running 0 3m23s\nmy-release-minio-1 1/1 Running 0 3m23s\nmy-release-minio-2 1/1 Running 0 3m23s\nmy-release-minio-3 1/1 Running 0 3m23s\nmy-release-pulsar-autorecovery-86f5dbdf77-lchpc 1/1 Running 0 3m24s\nmy-release-pulsar-bookkeeper-0 1/1 Running 0 3m23s\nmy-release-pulsar-bookkeeper-1 1/1 Running 0 98s\nmy-release-pulsar-broker-556ff89d4c-2m29m 1/1 Running 0 3m23s\nmy-release-pulsar-proxy-6fbd75db75-nhg4v 1/1 Running 0 3m23s\nmy-release-pulsar-zookeeper-0 1/1 Running 0 3m23s\nmy-release-pulsar-zookeeper-metadata-98zbr 0/1 Completed 0 3m24s\n","$ kubectl get pod my-release-milvus-proxy-6bd7f5587-ds2xv --template\n='{{(index (index .spec.containers 0).ports 0).containerPort}}{{\"\\n\"}}'\n19530\n","$ kubectl port-forward service/my-release-milvus 27017:19530\nForwarding from 127.0.0.1:27017 -> 19530\n","$ kubectl port-forward --address 0.0.0.0 service/my-release-milvus 27017:19530\nForwarding from 0.0.0.0:27017 -> 19530\n","$ helm template my-release milvus/milvus > milvus_manifest.yaml\n","$ wget https://raw.githubusercontent.com/milvus-io/milvus/master/deployments/offline/requirements.txt\n$ wget https://raw.githubusercontent.com/milvus-io/milvus/master/deployments/offline/save_image.py\n","$ pip3 install -r requirements.txt\n$ python3 save_image.py --manifest milvus_manifest.yaml\n","$ for image in $(find . -type f -name \"*.tar.gz\") ; do gunzip -c $image | docker load; done\n","$ kubectl apply -f milvus_manifest.yaml\n","$ helm repo update\n$ helm upgrade my-release zilliztech/milvus\n","$ helm uninstall my-release\n"],"headingContent":"Run Milvus in Kubernetes with Helm","anchorList":[{"label":"Milvus in Kubernetes mit Helm starten","href":"Run-Milvus-in-Kubernetes-with-Helm","type":1,"isActive":false},{"label":"Übersicht","href":"Overview","type":2,"isActive":false},{"label":"Voraussetzungen","href":"Prerequisites","type":2,"isActive":false},{"label":"Milvus Helm Chart installieren","href":"Install-Milvus-Helm-Chart","type":2,"isActive":false},{"label":"Online-Installation","href":"Online-install","type":2,"isActive":false},{"label":"Offline-Installation","href":"Offline-install","type":2,"isActive":false},{"label":"Upgrade des laufenden Milvus-Clusters","href":"Upgrade-running-Milvus-cluster","type":2,"isActive":false},{"label":"Milvus deinstallieren","href":"Uninstall-Milvus","type":2,"isActive":false},{"label":"Wie geht es weiter?","href":"Whats-next","type":2,"isActive":false}]}
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ NAME PROVISIONER RECLAIMPOLICY VOLUMEBIINDI
<li><p>Es wird empfohlen, vor der Installation von Milvus das <a href="https://milvus.io/tools/sizing">Milvus Sizing Tool</a> zu verwenden, um die Hardware-Anforderungen auf der Grundlage Ihrer Datengröße abzuschätzen. Dies hilft, eine optimale Leistung und Ressourcenzuweisung für Ihre Milvus-Installation zu gewährleisten.</p></li>
</ul>
<div class="alert note">
<p>Sollten Sie beim Ziehen des Images auf Probleme stoßen, kontaktieren Sie uns unter <a href="mailto:[email protected]">[email protected]</a> und schildern Sie uns das Problem.</p>
<p>Sollten Sie beim Ziehen des Images auf Probleme stoßen, wenden Sie sich bitte an <a href="mailto:[email protected]">[email protected]</a> und schildern Sie das Problem, damit wir Ihnen die notwendige Unterstützung bieten können.</p>
</div>
<h2 id="Install-Milvus-Helm-Chart" class="common-anchor-header">Milvus Helm Chart installieren<button data-href="#Install-Milvus-Helm-Chart" class="anchor-icon" translate="no">
<svg translate="no"
Expand All @@ -83,18 +83,18 @@ NAME PROVISIONER RECLAIMPOLICY VOLUMEBIINDI
></path>
</svg>
</button></h2><p>Bevor Sie Milvus Helm Charts installieren, müssen Sie das Milvus Helm Repository hinzufügen.</p>
<pre><code translate="no">$ helm repo <span class="hljs-keyword">add</span> milvus https:<span class="hljs-comment">//github.com/zilliztech/milvus-helm</span>
<pre><code translate="no">$ helm repo <span class="hljs-keyword">add</span> milvus https:<span class="hljs-comment">//zilliztech.github.io/milvus-helm/</span>
<button class="copy-code-btn"></button></code></pre>
<div class="alert note">
<p>Das Milvus Helm Charts-Repository unter <code translate="no">https://github.com/milvus-io/milvus-helm</code> wurde archiviert und Sie können weitere Aktualisierungen wie folgt von <code translate="no">https://github.com/zilliztech/milvus-helm</code> erhalten:</p>
<pre><code translate="no" class="language-shell">helm repo add zilliztech https://github.com/zilliztech/milvus-helm
<pre><code translate="no" class="language-shell">helm repo add zilliztech https://zilliztech.github.io/milvus-helm/
helm repo update
<span class="hljs-comment"># upgrade existing helm release</span>
helm upgrade my-release zilliztech/milvus
<button class="copy-code-btn"></button></code></pre>
<p>Das archivierte Repository ist weiterhin für die Diagramme bis 4.0.31 verfügbar. Für spätere Versionen verwenden Sie stattdessen das neue Repo.</p>
</div>
<p>Holen Sie sich dann die Milvus-Diagramme wie folgt aus dem Repository:</p>
<p>Holen Sie sich dann die Milvus-Charts wie folgt aus dem Repository:</p>
<pre><code translate="no">$ helm repo update
<button class="copy-code-btn"></button></code></pre>
<p>Sie können diesen Befehl jederzeit ausführen, um die neuesten Milvus Helm-Diagramme abzurufen.</p>
Expand All @@ -120,9 +120,9 @@ helm upgrade my-release zilliztech/milvus
<p>Mit dem obigen Befehl wird ein Milvus-Cluster mit seinen Komponenten und Abhängigkeiten unter Verwendung von Standardkonfigurationen bereitgestellt. Um diese Einstellungen anzupassen, empfehlen wir Ihnen, das <a href="https://milvus.io/tools/sizing">Milvus Sizing Tool</a> zu verwenden, um die Konfigurationen basierend auf Ihrer tatsächlichen Datengröße anzupassen und dann die entsprechende YAML-Datei herunterzuladen. Weitere Informationen zu den Konfigurationsparametern finden Sie in der <a href="https://milvus.io/docs/system_configuration.md">Milvus System Configurations Checklist</a>.</p>
<div class="alert note">
<ul>
<li>Der Versionsname sollte nur Buchstaben, Zahlen und Bindestriche enthalten. Punkte sind im Versionsnamen nicht erlaubt.</li>
<li>Der Release-Name sollte nur Buchstaben, Zahlen und Bindestriche enthalten. Punkte sind im Versionsnamen nicht erlaubt.</li>
<li>Die Standard-Befehlszeile installiert die Cluster-Version von Milvus bei der Installation von Milvus mit Helm. Bei der Installation von Milvus als Einzelplatzversion sind weitere Einstellungen erforderlich.</li>
<li>Gemäß dem <a href="https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-25">veralteten API-Migrationsleitfaden von Kubernetes</a> wird die API-Version <b>policy/v1beta1</b> von PodDisruptionBudget ab v1.25 nicht mehr unterstützt. Es wird empfohlen, Manifeste und API-Clients zu migrieren, um stattdessen die <b>policy/v1-API-Version</b> zu verwenden. <br/>Als Workaround für Benutzer, die noch die API-Version <b>policy/v1beta1</b> von PodDisruptionBudget auf Kubernetes v1.25 und höher verwenden, können Sie stattdessen den folgenden Befehl ausführen, um Milvus zu installieren:<br/> <code translate="no">helm install my-release milvus/milvus --set pulsar.bookkeeper.pdb.usePolicy=false,pulsar.broker.pdb.usePolicy=false,pulsar.proxy.pdb.usePolicy=false,pulsar.zookeeper.pdb.usePolicy=false</code></li>
<li>Gemäß dem <a href="https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-25">veralteten API-Migrationsleitfaden von Kubernetes</a> wird die API-Version <b>policy/v1beta1</b> von PodDisruptionBudget ab v1.25 nicht mehr unterstützt. Es wird empfohlen, Manifeste und API-Clients zu migrieren, um stattdessen die <b>policy/v1-API-Version</b> zu verwenden. <br/>Als Workaround für Benutzer, die noch die API-Version <b>policy/v1beta1</b> von PodDisruptionBudget auf Kubernetes v1.25 und später verwenden, können Sie stattdessen den folgenden Befehl ausführen, um Milvus zu installieren:<br/> <code translate="no">helm install my-release milvus/milvus --set pulsar.bookkeeper.pdb.usePolicy=false,pulsar.broker.pdb.usePolicy=false,pulsar.proxy.pdb.usePolicy=false,pulsar.zookeeper.pdb.usePolicy=false</code></li>
<li>Siehe <a href="https://artifacthub.io/packages/helm/milvus/milvus">Milvus Helm Chart</a> und <a href="https://helm.sh/docs/">Helm</a> für weitere Informationen.</li>
</ul>
</div>
Expand Down Expand Up @@ -204,7 +204,7 @@ $ wget <span class="hljs-attr">https</span>:<span class="hljs-comment">//raw.git
$ python3 save_image.py --manifest milvus_manifest.yaml
<button class="copy-code-btn"></button></code></pre>
<p>Die Bilder werden in einem Unterordner namens <code translate="no">images</code> im aktuellen Verzeichnis gespeichert.</p>
<h3 id="4-Load-images" class="common-anchor-header">4. Bilder laden</h3><p>Sie können nun die Bilder wie folgt auf die Hosts in der netzbeschränkten Umgebung laden:</p>
<h3 id="4-Load-images" class="common-anchor-header">4. Bilder laden</h3><p>Sie können die Bilder nun wie folgt auf die Hosts in der netzbeschränkten Umgebung laden:</p>
<pre><code translate="no" class="language-shell">$ <span class="hljs-keyword">for</span> image <span class="hljs-keyword">in</span> $(find . -<span class="hljs-built_in">type</span> f -name <span class="hljs-string">&quot;*.tar.gz&quot;</span>) ; <span class="hljs-keyword">do</span> gunzip -c <span class="hljs-variable">$image</span> | docker load; <span class="hljs-keyword">done</span>
<button class="copy-code-btn"></button></code></pre>
<h3 id="5-Deploy-Milvus" class="common-anchor-header">5. Milvus bereitstellen</h3><pre><code translate="no" class="language-shell">$ kubectl apply -f milvus_manifest.yaml
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"codeList":["gpu:\n initMemSize: 0 #set the initial memory pool size.\n maxMemSize: 0 #maxMemSize sets the maximum memory usage limit. When the memory usage exceed initMemSize, Milvus will attempt to expand the memory pool. \n","gpu:\n initMemSize: 2048 #set the initial memory pool size.\n maxMemSize: 4096 #maxMemSize sets the maximum memory usage limit. When the memory usage exceed initMemSize, Milvus will attempt to expand the memory pool. \n","index_params = {\n \"metric_type\": \"L2\",\n \"index_type\": \"GPU_CAGRA\",\n \"params\": {\n 'intermediate_graph_degree': 64,\n 'graph_degree': 32\n }\n}\n","index_params = {\n \"metric_type\": \"L2\",\n \"index_type\": \"GPU_IVF_FLAT\", # Or GPU_IVF_PQ\n \"params\": {\n \"nlist\": 1024\n }\n}\n","index_params = {\n 'index_type': 'GPU_BRUTE_FORCE',\n 'metric_type': 'L2',\n 'params': {}\n}\n","# Get an existing collection\ncollection = Collection(\"YOUR_COLLECTION_NAME\")\n\ncollection.create_index(\n field_name=\"vector\", # Name of the vector field on which an index is built\n index_params=index_params\n)\n","search_params = {\n \"metric_type\": \"L2\",\n \"params\": {}\n}\n","search_params = {\n \"metric_type\": \"L2\",\n \"params\": {\n \"itopk_size\": 128,\n \"search_width\": 4,\n \"min_iterations\": 0,\n \"max_iterations\": 0,\n \"team_size\": 0\n }\n}\n","search_params = {\n \"metric_type\": \"L2\", \n \"params\": {\"nprobe\": 10}\n}\n","# Load data into memory\ncollection.load()\n\ncollection.search(\n data=[[query_vector]], # Your query vector\n anns_field=\"vector\", # Name of the vector field\n param=search_params,\n limit=100 # Number of the results to return\n)\n"],"headingContent":"","anchorList":[{"label":"Index mit GPU","href":"Index-with-GPU","type":1,"isActive":false},{"label":"Konfigurieren Sie die Milvus-Einstellungen für die GPU-Speichersteuerung","href":"Configure-Milvus-settings-for-GPU-memory-control","type":2,"isActive":false},{"label":"Einen Index erstellen","href":"Build-an-index","type":2,"isActive":false},{"label":"Suche","href":"Search","type":2,"isActive":false},{"label":"Grenzen","href":"Limits","type":2,"isActive":false},{"label":"FAQ","href":"FAQ","type":2,"isActive":false}]}
{"codeList":["gpu:\n initMemSize: 0 #set the initial memory pool size.\n maxMemSize: 0 #maxMemSize sets the maximum memory usage limit. When the memory usage exceed initMemSize, Milvus will attempt to expand the memory pool. \n","gpu:\n initMemSize: 2048 #set the initial memory pool size.\n maxMemSize: 4096 #maxMemSize sets the maximum memory usage limit. When the memory usage exceed initMemSize, Milvus will attempt to expand the memory pool. \n","index_params = {\n \"metric_type\": \"L2\",\n \"index_type\": \"GPU_CAGRA\",\n \"params\": {\n 'intermediate_graph_degree': 64,\n 'graph_degree': 32\n }\n}\n","index_params = {\n \"metric_type\": \"L2\",\n \"index_type\": \"GPU_IVF_FLAT\", # Or GPU_IVF_PQ\n \"params\": {\n \"nlist\": 1024\n }\n}\n","index_params = {\n 'index_type': 'GPU_BRUTE_FORCE',\n 'metric_type': 'L2',\n 'params': {}\n}\n","# Get an existing collection\ncollection = Collection(\"YOUR_COLLECTION_NAME\")\n\ncollection.create_index(\n field_name=\"vector\", # Name of the vector field on which an index is built\n index_params=index_params\n)\n","search_params = {\n \"metric_type\": \"L2\",\n \"params\": {}\n}\n","search_params = {\n \"metric_type\": \"L2\",\n \"params\": {\n \"itopk_size\": 128,\n \"search_width\": 4,\n \"min_iterations\": 0,\n \"max_iterations\": 0,\n \"team_size\": 0\n }\n}\n","search_params = {\n \"metric_type\": \"L2\", \n \"params\": {\"nprobe\": 10}\n}\n","# Load data into memory\ncollection.load()\n\ncollection.search(\n data=[[query_vector]], # Your query vector\n anns_field=\"vector\", # Name of the vector field\n param=search_params,\n limit=100 # Number of the results to return\n)\n"],"headingContent":"Index with GPU","anchorList":[{"label":"Index mit GPU","href":"Index-with-GPU","type":1,"isActive":false},{"label":"Konfigurieren Sie die Milvus-Einstellungen für die GPU-Speichersteuerung","href":"Configure-Milvus-settings-for-GPU-memory-control","type":2,"isActive":false},{"label":"Einen Index erstellen","href":"Build-an-index","type":2,"isActive":false},{"label":"Suche","href":"Search","type":2,"isActive":false},{"label":"Grenzen","href":"Limits","type":2,"isActive":false},{"label":"FAQ","href":"FAQ","type":2,"isActive":false}]}
Loading

0 comments on commit fb70e3d

Please sign in to comment.