Skip to content
This repository has been archived by the owner on Feb 21, 2022. It is now read-only.

milvus-io/milvus-insight

Repository files navigation

Notice: Unmaintained

This repo is no longer maintained.

However we have the Attu to help manage Milvus.

Milvus insight

typescript downloads codecov

Milvus insight provides an intuitive and efficient GUI for Milvus, allowing you to interact with your databases and manage your data with just few clicks.

Miluvs insight

Features and Roadmap

Milvus insight is under rapid development and we are adding new features weekly, here are the current plan, we will release a version once a feature is available.

  • Manage collections/partitions
  • Manage index
  • Basic statistics overview
  • Load/release collections for search
  • Insert entities
  • Vector search with advanced filter
  • Milvus system view(TBD)
  • Data view (TBD)
  • View milvus node configuration(TBD)
  • Vector Visualization(TBD)
  • More...

Quick start

Before you start

Ensure you have Milvus installed on your server or cluster, and Milvus insight only supports Milvus 2.x.

⭐️ Start a Milvus insight instance

docker run -p 8000:3000 -e HOST_URL=http://{ milvus insight ip }:8000 -e MILVUS_URL={milvus server ip}:19530 milvusdb/milvus-insight:latest

Once you start the docker, open the browser, type http://{ milvus insight ip }:8000, you can view the Milvus insight.

Params

Parameter Example required description
HOST_URL http://192.168.0.1:8000 true Where Milvus insight container is installed
MILVUS_URL 192.168.0.1:19530 false Optional, Milvus server URL

Tip: 127.0.0.1 or localhost will not work when runs on docker

Try the dev build

note We plan to release Milvus insight once a feature is done. Also, if you want to try the nightly build, please pull the docker image with the dev tag.

docker run -p 8000:3000 -e HOST_URL=http://{ your machine IP }:8000 -e MILVUS_URL={ your machine IP }:19530 milvusdb/milvus-insight:dev

✨ Building and Running Milvus insight, and/or Contributing Code

You might want to build Milvus-insight locally to contribute some code, test out the latest features, or try out an open PR:

Build server

  1. Fork and clone the repo
  2. cd server go to the server directory
  3. yarn install to install dependencies
  4. Create a branch for your PR

Build client

  1. Fork and clone the repo
  2. cd client go to the client directory
  3. yarn install to install dependencies
  4. Create a branch for your PR

Milvus

New to milvus? Milvus is an open-source vector database built to power AI applications and embedding similarity search.

Userful links

Community

👉 Join the Milvus community on Slack to share your suggestions, advice, and questions with our engineering team.

Miluvs Slack Channel

❓ Questions? Problems?

  • If you've found a bug or want to request a feature, please create a GitHub Issue. Please check to make sure someone else hasn't already created an issue for the same topic.
  • Need help using Milvus insight? Ask away on our Milvus insight Discuss Forum and a fellow community member or Milvus engineer will be glad to help you out.