Release new docs to master

milvus-io · Dec 31, 2024 · e0da199 · e0da199
1 parent 86fada3
commit e0da199
Show file tree

Hide file tree

Showing 9 changed files with 114 additions and 7 deletions.
diff --git a/v2.5.x/site/en/getstarted/run-milvus-docker/install_standalone-docker-compose.md b/v2.5.x/site/en/getstarted/run-milvus-docker/install_standalone-docker-compose.md
@@ -58,6 +58,10 @@ milvus-minio        /usr/bin/docker-entrypoint ...   Up (healthy)   9000/tcp
 milvus-standalone   /tini -- milvus run standalone   Up             0.0.0.0:19530->19530/tcp, 0.0.0.0:9091->9091/tcp
 ```
 
+You can also access Milvus WebUI at `http://127.0.0.1:9091/webui/` to learn more about the your Milvus instance. For details, refer to [Milvus WebUI](milvus-webui.md).
+
+## Stop and delete Milvus
+
 You can stop and delete this container as follows
 
 ```shell
@@ -88,6 +92,7 @@ Having installed Milvus in Docker, you can:
   - [Amazon EKS](eks.md)
   - [Google Cloud](gcp.md)
   - [Microsoft Azure](azure.md)
+- Explore [Milvus WebUI](milvus-webui.md), an intuitive web interface for Milvus observability and management.
 - Explore [Milvus Backup](milvus_backup_overview.md), an open-source tool for Milvus data backups.
 - Explore [Birdwatcher](birdwatcher_overview.md), an open-source tool for debugging Milvus and dynamic configuration updates.
 - Explore [Attu](https://github.com/zilliztech/attu), an open-source GUI tool for intuitive Milvus management.

diff --git a/v2.5.x/site/en/getstarted/run-milvus-docker/install_standalone-docker.md b/v2.5.x/site/en/getstarted/run-milvus-docker/install_standalone-docker.md
@@ -42,6 +42,10 @@ After running the installation script:
 - To change the default Milvus configuration, add your settings to the **user.yaml** file in the current folder and then restart the service.
 - The Milvus data volume is mapped to **volumes/milvus** in the current folder.
 
+You can access Milvus WebUI at `http://127.0.0.1:9091/webui/` to learn more about the your Milvus instance. For details, refer to [Milvus WebUI](milvus-webui.md).
+
+## Stop and delete Milvus
+
 You can stop and delete this container as follows
 
 ```shell
@@ -78,6 +82,7 @@ Having installed Milvus in Docker, you can:
   - [Amazon EKS](eks.md)
   - [Google Cloud](gcp.md)
   - [Microsoft Azure](azure.md)
+- Explore [Milvus WebUI](milvus-webui.md), an intuitive web interface for Milvus observability and management.
 - Explore [Milvus Backup](milvus_backup_overview.md), an open-source tool for Milvus data backups.
 - Explore [Birdwatcher](birdwatcher_overview.md), an open-source tool for debugging Milvus and dynamic configuration updates.
 - Explore [Attu](https://milvus.io/docs/attu.md), an open-source GUI tool for intuitive Milvus management.

diff --git a/v2.5.x/site/en/getstarted/run-milvus-docker/install_standalone-windows.md b/v2.5.x/site/en/getstarted/run-milvus-docker/install_standalone-windows.md
@@ -254,4 +254,29 @@ To deal with the error prompted during Milvus startup that reads "Read config fa
 ![List Milvus config files](../../../../assets/milvus-read-config-fails-02.png)
 
 
+## What's next
+
+Having installed Milvus in Docker, you can:
+
+- Check [Quickstart](quickstart.md) to see what Milvus can do.
+
+- Learn the basic operations of Milvus:
+  - [Manage Databases](manage_databases.md)
+  - [Manage Collections](manage-collections.md)
+  - [Manage Partitions](manage-partitions.md)
+  - [Insert, Upsert & Delete](insert-update-delete.md)
+  - [Single-Vector Search](single-vector-search.md)
+  - [Hybrid Search](multi-vector-search.md)
+
+- [Upgrade Milvus Using Helm Chart](upgrade_milvus_cluster-helm.md).
+- [Scale your Milvus cluster](scaleout.md).
+- Deploy your Milvu cluster on clouds:
+  - [Amazon EKS](eks.md)
+  - [Google Cloud](gcp.md)
+  - [Microsoft Azure](azure.md)
+- Explore [Milvus WebUI](milvus-webui.md), an intuitive web interface for Milvus observability and management.
+- Explore [Milvus Backup](milvus_backup_overview.md), an open-source tool for Milvus data backups.
+- Explore [Birdwatcher](birdwatcher_overview.md), an open-source tool for debugging Milvus and dynamic configuration updates.
+- Explore [Attu](https://milvus.io/docs/attu.md), an open-source GUI tool for intuitive Milvus management.
+- [Monitor Milvus with Prometheus](monitor.md).
 
diff --git a/v2.5.x/site/en/getstarted/run-milvus-gpu/install_cluster-helm-gpu.md b/v2.5.x/site/en/getstarted/run-milvus-gpu/install_cluster-helm-gpu.md
@@ -301,6 +301,21 @@ $ kubectl port-forward --address 0.0.0.0 service/my-release-milvus 27017:19530
 Forwarding from 0.0.0.0:27017 -> 19530
 ```
 
+Now, you can connect to Milvus using the forwarded port.
+
+## Access Milvus WebUI
+
+Milvus ships with a built-in GUI tool called Milvus WebUI that you can access through your browser. Milvus Web UI enhances system observability with a simple and intuitive interface. You can use Milvus Web UI to observe the statistics and metrics of the components and dependencies of Milvus, check database and collection details, and list detailed Milvus configurations. For details about Milvus Web UI, see [Milvus WebUI](milvus-webui.md)
+
+To enable the access to the Milvus Web UI, you need to port-forward the proxy pod to a local port.
+
+```shell
+$ kubectl port-forward --address 0.0.0.0 service/my-release-milvus 27018:9091
+Forwarding from 0.0.0.0:27018 -> 9091
+```
+
+Now, you can access Milvus Web UI at `http://localhost:27018`.
+
 ## Uninstall Milvus
 
 Run the following command to uninstall Milvus.
@@ -329,6 +344,7 @@ Having installed Milvus, you can:
   - [Amazon EKS](eks.md)
   - [Google Cloud](gcp.md)
   - [Microsoft Azure](azure.md)
+- Explore [Milvus WebUI](milvus-webui.md), an intuitive web interface for Milvus observability and management.
 - Explore [Milvus Backup](milvus_backup_overview.md), an open-source tool for Milvus data backups.
 - Explore [Birdwatcher](birdwatcher_overview.md), an open-source tool for debugging Milvus and dynamic configuration updates.
 - Explore [Attu](https://milvus.io/docs/attu.md), an open-source GUI tool for intuitive Milvus management.

diff --git a/v2.5.x/site/en/getstarted/run-milvus-gpu/install_standalone-docker-compose-gpu.md b/v2.5.x/site/en/getstarted/run-milvus-gpu/install_standalone-docker-compose-gpu.md
@@ -106,6 +106,8 @@ milvus-minio        /usr/bin/docker-entrypoint ...   Up (healthy)   9000/tcp
 milvus-standalone   /tini -- milvus run standalone   Up             0.0.0.0:19530->19530/tcp, 0.0.0.0:9091->9091/tcp
 ```
 
+You can also access Milvus WebUI at `http://127.0.0.1:9091/webui/` to learn more about the your Milvus instance. For details, refer to [Milvus WebUI](milvus-webui.md).
+
 If you have assigned multiple GPU devices to Milvus in docker-compose.yml, you can specify which GPU device is visible or available for use.
 
 Make GPU device `0` visible to Milvus:
@@ -186,6 +188,8 @@ Having installed Milvus in Docker, you can:
 
 - Check [Quickstart](quickstart.md) to see what Milvus can do.
 
+- Check [Milvus WebUI](milvus-webui.md) to learn more about the Milvus instance.
+
 - Learn the basic operations of Milvus:
   - [Manage Databases](manage_databases.md)
   - [Manage Collections](manage-collections.md)
@@ -200,6 +204,7 @@ Having installed Milvus in Docker, you can:
   - [Amazon EKS](eks.md)
   - [Google Cloud](gcp.md)
   - [Microsoft Azure](azure.md)
+- Explore [Milvus WebUI](milvus-webui.md), an intuitive web interface for Milvus observability and management.
 - Explore [Milvus Backup](milvus_backup_overview.md), an open-source tool for Milvus data backups.
 - Explore [Birdwatcher](birdwatcher_overview.md), an open-source tool for debugging Milvus and dynamic configuration updates.
 - Explore [Attu](https://milvus.io/docs/attu.md), an open-source GUI tool for intuitive Milvus management.

diff --git a/v2.5.x/site/en/getstarted/run-milvus-k8s/install_cluster-helm.md b/v2.5.x/site/en/getstarted/run-milvus-k8s/install_cluster-helm.md
@@ -124,6 +124,8 @@ my-release-pulsar-zookeeper-0                    1/1    Running   0        3m23s
 my-release-pulsar-zookeeper-metadata-98zbr       0/1   Completed  0        3m24s
 ```
 
+You can also access Milvus WebUI at `http://127.0.0.1:9091/webui/` to learn more about the your Milvus instance. For details, refer to [Milvus WebUI](milvus-webui.md).
+
 ### 3. Forward a local port to Milvus
 
 Run the following command to get the port at which your Milvus cluster serves.
@@ -153,11 +155,41 @@ Optionally, you can use `:19530` instead of `27017:19530` in the above command t
 
 By default, kubectl's port-forwarding only listens on `localhost`. Use the `address` flag if you want Milvus to listen on the selected or all IP addresses. The following command makes port-forward listen on all IP addresses on the host machine.
 
+Now, you can connect to Milvus using the forwarded port.
+
+## Access Milvus WebUI
+
+Milvus ships with a built-in GUI tool called Milvus WebUI that you can access through your browser. Milvus Web UI enhances system observability with a simple and intuitive interface. You can use Milvus Web UI to observe the statistics and metrics of the components and dependencies of Milvus, check database and collection details, and list detailed Milvus configurations. For details about Milvus Web UI, see [Milvus WebUI](milvus-webui.md)
+
+To enable the access to the Milvus Web UI, you need to port-forward the proxy pod to a local port.
+
+```shell
+$ kubectl port-forward --address 0.0.0.0 service/my-release-milvus 27018:9091
+Forwarding from 0.0.0.0:27018 -> 9091
+```
+
+Now, you can access Milvus Web UI at `http://localhost:27018`.
+
 ```bash
 $ kubectl port-forward --address 0.0.0.0 service/my-release-milvus 27017:19530
 Forwarding from 0.0.0.0:27017 -> 19530
 ```
 
+Now, you can connect to Milvus using the forwarded port.
+
+## Access Milvus WebUI
+
+Milvus ships with a built-in GUI tool called Milvus WebUI that you can access through your browser. Milvus Web UI enhances system observability with a simple and intuitive interface. You can use Milvus Web UI to observe the statistics and metrics of the components and dependencies of Milvus, check database and collection details, and list detailed Milvus configurations. For details about Milvus Web UI, see [Milvus WebUI](milvus-webui.md)
+
+To enable the access to the Milvus Web UI, you need to port-forward the proxy pod to a local port.
+
+```shell
+$ kubectl port-forward --address 0.0.0.0 service/my-release-milvus 27018:9091
+Forwarding from 0.0.0.0:27018 -> 9091
+```
+
+Now, you can access Milvus Web UI at `http://localhost:27018`.
+
 ## Offline install
 
 If you are in a network-restricted environment, follow the procedure in this section to start a Milvus cluster.
@@ -252,6 +284,7 @@ Having installed Milvus in Docker, you can:
   - [Amazon EKS](eks.md)
   - [Google Cloud](gcp.md)
   - [Microsoft Azure](azure.md)
+- Explore [Milvus WebUI](milvus-webui.md), an intuitive web interface for Milvus observability and management.
 - Explore [Milvus Backup](milvus_backup_overview.md), an open-source tool for Milvus data backups.
 - Explore [Birdwatcher](birdwatcher_overview.md), an open-source tool for debugging Milvus and dynamic configuration updates.
 - Explore [Attu](https://milvus.io/docs/attu.md), an open-source GUI tool for intuitive Milvus management.

diff --git a/v2.5.x/site/en/getstarted/run-milvus-k8s/install_cluster-milvusoperator.md b/v2.5.x/site/en/getstarted/run-milvus-k8s/install_cluster-milvusoperator.md
@@ -293,6 +293,21 @@ $ kubectl port-forward --address 0.0.0.0 service/my-release-milvus 27017:19530
 Forwarding from 0.0.0.0:27017 -> 19530
 ```
 
+Now, you can connect to Milvus using the forwarded port.
+
+## Access Milvus WebUI
+
+Milvus ships with a built-in GUI tool called Milvus WebUI that you can access through your browser. Milvus Web UI enhances system observability with a simple and intuitive interface. You can use Milvus Web UI to observe the statistics and metrics of the components and dependencies of Milvus, check database and collection details, and list detailed Milvus configurations. For details about Milvus Web UI, see [Milvus WebUI](milvus-webui.md)
+
+To enable the access to the Milvus Web UI, you need to port-forward the proxy pod to a local port.
+
+```shell
+$ kubectl port-forward --address 0.0.0.0 service/my-release-milvus 27018:9091
+Forwarding from 0.0.0.0:27018 -> 9091
+```
+
+Now, you can access Milvus Web UI at `http://localhost:27018`.
+
 ## Uninstall Milvus
 
 Run the following command to uninstall the Milvus cluster.
@@ -347,6 +362,7 @@ Having installed Milvus in Docker, you can:
   - [Amazon EKS](eks.md)
   - [Google Cloud](gcp.md)
   - [Microsoft Azure](azure.md)
+- Explore [Milvus WebUI](milvus-webui.md), an intuitive web interface for Milvus observability and management.
 - Explore [Milvus Backup](milvus_backup_overview.md), an open-source tool for Milvus data backups.
 - Explore [Birdwatcher](birdwatcher_overview.md), an open-source tool for debugging Milvus and dynamic configuration updates.
 - Explore [Attu](https://milvus.io/docs/attu.md), an open-source GUI tool for intuitive Milvus management.

diff --git a/v2.5.x/site/en/menuStructure/en.json b/v2.5.x/site/en/menuStructure/en.json
@@ -1389,6 +1389,12 @@
             "children": []
           }
         ]
+      },
+      {
+        "label": "Milvus WebUI",
+        "id": "milvus-webui.md",
+        "order": "12",
+        "children": []
       }
     ]
   },
@@ -1424,12 +1430,6 @@
           }
         ]
       },
-      {
-        "label": "Milvus WebUI",
-        "id": "milvus-webui.md",
-        "order": "1",
-        "children": []
-      },
       {
         "label": "Milvus Backup",
         "id": "milvus_backup",

diff --git a/v2.5.x/site/en/userGuide/tools/milvus-webui.md b/v2.5.x/site/en/userGuide/tools/milvus-webui.md
@@ -21,13 +21,15 @@ The following table compares the features of Milvus Web UI and Birdwatcher/Attu:
 | Installation | Built-in | Standalone tool | Standalone tool |
 | Dependencies | Milvus | Milvus / etcd | Milvus |
 | Primary Functionalities | Runtime environment, database/collection details, segments, channles, tasks, and slow query requests | Metadata inspection and Milvus API execution | Database management and operational tasks |
+| Available since | v2.5.0 | v2.0.0 | v0.1.8 |
 
-You can access Milvus Web UI using the following URL:
+As of v2.5.0, you can access Milvus Web UI using the following URL on a running Milvus instance:
 
 ```
 http://${MILVUS_PROXY_IP}:9091/webui
 ```
 
+
 ## Features
 
 Milvus Web UI provides the following features: