From 8e49450a7e3aec573c713ab774421534145fc746 Mon Sep 17 00:00:00 2001 From: AnthonyTsu1984 <115786031+AnthonyTsu1984@users.noreply.github.com> Date: Tue, 29 Aug 2023 15:34:14 +0800 Subject: [PATCH 1/2] remove restrictions from configure_minio.md Signed-off-by: AnthonyTsu1984 <115786031+AnthonyTsu1984@users.noreply.github.com> --- site/en/reference/sys_config/configure_minio.md | 1 - 1 file changed, 1 deletion(-) diff --git a/site/en/reference/sys_config/configure_minio.md b/site/en/reference/sys_config/configure_minio.md index 5f97c2592..6bff8efbd 100644 --- a/site/en/reference/sys_config/configure_minio.md +++ b/site/en/reference/sys_config/configure_minio.md @@ -124,7 +124,6 @@ To share a MinIO instance among multiple Milvus instances, you need to change
  • Switch value to control if to access the MinIO or S3 service through SSL.
    • -
  • Milvus 2.0.0 does not support secure access to MinIO or S3 service. Future releases will support secure access to MinIO.
    • false From a697a342378e5666dd8eeb5cf7d889fbb0398db2 Mon Sep 17 00:00:00 2001 From: AnthonyTsu1984 <115786031+AnthonyTsu1984@users.noreply.github.com> Date: Tue, 29 Aug 2023 17:47:24 +0800 Subject: [PATCH 2/2] add dynamic configurations Signed-off-by: AnthonyTsu1984 <115786031+AnthonyTsu1984@users.noreply.github.com> --- site/en/adminGuide/configure_milvus.md | 14 -- site/en/adminGuide/dynamic_config.md | 134 ++++++++++++++++++ .../upgrade_milvus_cluster-operator.md | 6 +- .../upgrade_milvus_standalone-operator.md | 6 +- site/en/menuStructure/en.json | 8 ++ .../tools/birdwatcher_usage_guides.md | 2 +- 6 files changed, 149 insertions(+), 21 deletions(-) delete mode 100644 site/en/adminGuide/configure_milvus.md create mode 100644 site/en/adminGuide/dynamic_config.md diff --git a/site/en/adminGuide/configure_milvus.md b/site/en/adminGuide/configure_milvus.md deleted file mode 100644 index 4e25b53c6..000000000 --- a/site/en/adminGuide/configure_milvus.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -id: configure_milvus.md -title: Configure Milvus ---- - -# Configure Milvus - -There are several ways to configure Milvus components: - -- [Docker Compose](configure-docker.md) - -- [Helm](configure-helm.md) - -- [Milvus Operator](configure_operator.md) diff --git a/site/en/adminGuide/dynamic_config.md b/site/en/adminGuide/dynamic_config.md new file mode 100644 index 000000000..d6727e0d1 --- /dev/null +++ b/site/en/adminGuide/dynamic_config.md @@ -0,0 +1,134 @@ +--- +id: dynamic_config.md +related_key: configure +group: system_configuration.md +summary: Learn about the system configuration of Milvus. +--- + +# Configure Milvus on the Fly + +Milvus allows you to change some of its configurations on the fly. + +## Before you start + +You need to ensure that： + +- You have Birdwatcher installed. For details, refer to [Install Birdwatcher](birdwatcher_install_guides.md), +- You have etcdctl installed. For details, refer to [Interacting with etcd](https://etcd.io/docs/v3.5/dev-guide/interacting_v3/), or +- You have other etcd clients, such as the Python client, installed. + +
    + +- Examples in this guide change the value of `proxy.minPasswordLength` to `8`. You can replace the key with the applicable ones listed in +- Examples in this guide assume that the root path of your Milvus is `by-dev`. All configurations are listed under the path `by-dev/config`. The Milvus root path varies with the way you install it. For the instances installed using the Helm charts, the root path defaults to `by-dev`. If you do not know the root path, refer to [Connect to etcd](birdwatcher_usage_guides.md#Connect-to-etcd). + +
    + +## Change configurations + +On Milvus, `proxy.minPasswordLength` is set to `6` by default. To change this value, you can do as follows: + +```shell +$ etcdctl put by-dev/config/proxy/minPasswordLength 8 +# or +$ birdwatcher -olc "#connect --etcd 127.0.0.1:2379 --rootPath=by-dev,set config-etcd --key by-dev/config/proxy/minPasswordLength --value 8" +``` + +Then you can check the configurations as follows: + +```shell +$ etcdctl get by-dev/config/proxy/minPasswordLength +``` + +## Roll back configurations + +Milvus also allows you to roll back your configurations in case the changed value no longer applies. + +```shell +$ etcdctl del by-dev/config/proxy/minPasswordLength +# or +$ birdwatcher -olc "#connect --etcd 127.0.0.1:2379 --rootPath=by-dev,remove config-etcd --key by-dev/config/proxy/minPasswordLength" +``` + +Then you can check the configurations as follows: + +```shell +$ etcdctl get by-dev/config/proxy/minPasswordLength +``` + +## View configurations + +Instead of viewing the value of a specific configuration item, you can also list all of them. + +```shell +$ etcdctl get --prefix by-dev/config +# or +$ birdwatcher -olc "#connect --etcd 127.0.0.1:2379 --rootPath=by-dev,show config-etcd" +``` + +To view the configurations of a specific node: + +```shell +Offline > connect --etcd ip:port +Milvus(by-dev) > show session # List all nodes with their server ID +Milvus(by-dev) > visit querycoord 1 # Visit a node by server ID +QueryCoord-1(ip:port) > configuration # List the configuration of the node +``` + +## Applicable configuration items + +Currently, you can change the following configuration items on the fly. + + | Configuration item | Default value | + |-------------------------------------------------------------------------|---------------------| + | pulsar.maxMessageSize | 5242880 | + | common.retentionDuration | 86400 | + | common.entityExpiration | -1 | + | common.gracefulTime | 5000 | + | common.gracefulStopTimeout | 30 | + | quotaAndLimits.ddl.enabled | FALSE | + | quotaAndLimits.indexRate.enabled | FALSE | + | quotaAndLimits.flushRate.enabled | FALSE | + | quotaAndLimits.compactionRate.enabled | FALSE | + | quotaAndLimits.dml.enabled | FALSE | + | quotaAndLimits.dql.enabled | FALSE | + | quotaAndLimits.limits.collection.maxNum | 64 | + | quotaAndLimits.limitWriting.forceDeny | FALSE | + | quotaAndLimits.limitWriting.ttProtection.enabled | FALSE | + | quotaAndLimits.limitWriting.ttProtection.maxTimeTickDelay | 9223372036854775807 | + | quotaAndLimits.limitWriting.memProtection.enabled | TRUE | + | quotaAndLimits.limitWriting.memProtection.dataNodeMemoryLowWaterLevel | 0.85 | + | quotaAndLimits.limitWriting.memProtection.dataNodeMemoryHighWaterLevel | 0.95 | + | quotaAndLimits.limitWriting.memProtection.queryNodeMemoryLowWaterLevel | 0.85 | + | quotaAndLimits.limitWriting.memProtection.queryNodeMemoryHighWaterLevel | 0.95 | + | quotaAndLimits.limitWriting.diskProtection.enabled | TRUE | + | quotaAndLimits.limitWriting.diskProtection.diskQuota | +INF | + | quotaAndLimits.limitReading.forceDeny | FALSE | + | quotaAndLimits.limitReading.queueProtection.enabled | FALSE | + | quotaAndLimits.limitReading.queueProtection.nqInQueueThreshold | 9223372036854775807 | + | quotaAndLimits.limitReading.queueProtection.queueLatencyThreshold | +INF | + | quotaAndLimits.limitReading.resultProtection.enabled | FALSE | + | quotaAndLimits.limitReading.resultProtection.maxReadResultRate | +INF | + | quotaAndLimits.limitReading.coolOffSpeed | 0.9 | + | autoIndex.enable | FALSE | + | autoIndex.params.build | "" | + | autoIndex.params.extra | "" | + | autoIndex.params.search | "" | + | proxy.maxNameLength | 255 | + | proxy.maxUsernameLength | 32 | + | proxy.minPasswordLength | 6 | + | proxy.maxPasswordLength | 256 | + | proxy.maxFieldNum | 64 | + | proxy.maxShardNum | 256 | + | proxy.maxDimension | 32768 | + | proxy.maxUserNum | 100 | + | proxy.maxRoleNum | 10 | + | queryNode.enableDisk | TRUE | + | dataCoord.segment.diskSegmentMaxSize | 2048 | + | dataCoord.compaction.enableAutoCompaction | TRUE | + + +## What's next + +- Learn more about [System Configurations](system-configuration). +- Learn how to configure Milvus installed using [Milvus Operator](configure-operator.md), [Helm charts](configure-helm), and [Docker](configure-docker). diff --git a/site/en/adminGuide/upgrade_milvus_cluster-operator.md b/site/en/adminGuide/upgrade_milvus_cluster-operator.md index b62e33eec..26f55dd8d 100644 --- a/site/en/adminGuide/upgrade_milvus_cluster-operator.md +++ b/site/en/adminGuide/upgrade_milvus_cluster-operator.md @@ -18,9 +18,9 @@ This guide describes how to upgrade your Milvus cluster with Milvus operator. Run the following command to upgrade the version of your Milvus Operator to v{{var.milvus_operator_version}}. ``` -helm repo add milvus-operator https://milvus-io.github.io/milvus-operator/ -helm repo update milvus-operator -helm -n milvus-operator upgrade milvus-operator milvus-operator/milvus-operator +helm repo add zilliztech-milvus-operator https://zilliztech.github.io/milvus-operator/ +helm repo update zilliztech-milvus-operator +helm -n milvus-operator upgrade milvus-operator zilliztech-milvus-operator/milvus-operator ``` Once you have upgraded your Milvus operator to the latest version, you have the following choices: diff --git a/site/en/adminGuide/upgrade_milvus_standalone-operator.md b/site/en/adminGuide/upgrade_milvus_standalone-operator.md index a5bff388d..ccb770082 100644 --- a/site/en/adminGuide/upgrade_milvus_standalone-operator.md +++ b/site/en/adminGuide/upgrade_milvus_standalone-operator.md @@ -18,9 +18,9 @@ This guide describes how to upgrade your Milvus standalone with Milvus operator. Run the following command to upgrade the version of your Milvus operator to v{{var.milvus_operator_version}}. ``` -helm repo add milvus-operator https://milvus-io.github.io/milvus-operator/ -helm repo update milvus-operator -helm -n milvus-operator upgrade milvus-operator milvus-operator/milvus-operator +helm repo add zilliztech-milvus-operator https://zilliztech.github.io/milvus-operator/ +helm repo update zilliztech-milvus-operator +helm -n milvus-operator upgrade milvus-operator zilliztech-milvus-operator/milvus-operator ``` Once you have upgraded your Milvus operator to the latest version, you have the following choices: diff --git a/site/en/menuStructure/en.json b/site/en/menuStructure/en.json index c30143621..129c90ae5 100644 --- a/site/en/menuStructure/en.json +++ b/site/en/menuStructure/en.json @@ -494,6 +494,14 @@ "label3": "", "order": 2 }, + { + "id": "dynamic_config.md", + "title": "On the Fly", + "label1": "admin_guide", + "label2": "configure_milvus", + "label3": "", + "order": 3 + }, { "id": "configure_operator.md", "title": "With Milvus Operator", diff --git a/site/en/userGuide/tools/birdwatcher_usage_guides.md b/site/en/userGuide/tools/birdwatcher_usage_guides.md index f684ed4c8..1b9bef645 100644 --- a/site/en/userGuide/tools/birdwatcher_usage_guides.md +++ b/site/en/userGuide/tools/birdwatcher_usage_guides.md @@ -9,7 +9,7 @@ This guide walks you through how to use Birdwatcher to check the state of your M ## Start Birdwatcher -Birdwatcher is an command-line tool, you can start it as follows: +Birdwatcher is a command-line tool, you can start it as follows: ```shell ./birdwatcher