Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md and DEVELOPMENT.md #6173

Merged
merged 1 commit into from
Jun 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
[skip ci] Update README.md and DEVELOPMENT.md
Signed-off-by: quicksilver <zhifeng.zhang@zilliz.com>
  • Loading branch information
jeffoverflow committed Jun 28, 2021
commit d877892ad51bbfd1aa16a1fa42514e0d33a305f8
27 changes: 23 additions & 4 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ Milvus is written in Go and C++, compiling it can use a lot of resources. We rec

In fact, all Linux distributions is available to develop Milvus. The following only contains commands on Ubuntu, because we mainly use it. If you develop Milvus on other distributions, you are welcome to improve this document.

#### Debian/Ubuntu
#### Dependencies
- Debian/Ubuntu

```shell
sudo apt update
Expand All @@ -29,6 +30,21 @@ sudo apt install -y build-essential ccache gfortran \
libboost-filesystem-dev libboost-serialization-dev libboost-python-dev
```

- CentOS

```shell
sudo yum install -y epel-release centos-release-scl-rh \
&& sudo yum install -y make automake openssl-devel zlib-devel tbb-devel \
libcurl-devel python3-devel boost-devel boost-python \
devtoolset-7-gcc devtoolset-7-gcc-c++ devtoolset-7-gcc-gfortran \
llvm-toolset-7.0-clang llvm-toolset-7.0-clang-tools-extra

echo "source scl_source enable devtoolset-7" | sudo tee -a /etc/profile.d/devtoolset-7.sh
echo "source scl_source enable llvm-toolset-7.0" | sudo tee -a /etc/profile.d/llvm-toolset-7.sh
echo "export CLANG_TOOLS_PATH=/opt/rh/llvm-toolset-7.0/root/usr/bin" | sudo tee -a /etc/profile.d/llvm-toolset-7.sh
source "/etc/profile.d/llvm-toolset-7.sh"
```

Once you have finished, confirm that `gcc` and `make` are installed:

```shell
Expand Down Expand Up @@ -100,16 +116,19 @@ Milvus uses Python SDK to write test cases to verify the correctness of Milvus f
#### Standalone

```shell
cd deployments/docker/standalone
cd deployments/docker/dev
docker-compose up -d
cd ../../../
./bin/milvus run standalone
./scripts/start_standalone.sh
```

#### Cluster

```shell
./scripts/start.sh
cd deployments/docker/dev
docker-compose up -d
cd ../../../
./scripts/start_cluster.sh
```

To run E2E tests, use these command:
Expand Down
76 changes: 0 additions & 76 deletions INSTALL.md

This file was deleted.

55 changes: 11 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@


<div class="column" align="middle">
<a href="https://internal.zilliz.com:18080/jenkins/job/milvus-ha-ci/job/master/badge/">
<img src="https://internal.zilliz.com:18080/jenkins/job/milvus-ha-ci/job/master/badge/icon" />
<a href="https://ci.milvus.io:18080/jenkins/job/milvus-ha-ci/job/master/badge/">
<img src="https://ci.milvus.io:18080/jenkins/job/milvus-ha-ci/job/master/badge/icon" />
</a>
<a href="https://bestpractices.coreinfrastructure.org/projects/3563">
<img src="https://bestpractices.coreinfrastructure.org/projects/3563/badge" />
Expand Down Expand Up @@ -84,62 +84,29 @@ Milvus was released under the [open-source Apache License 2.0](https://github.co



## Installation
## Quick start

### Install Milvus Standalone
### To start using Milvus

#### Install with Docker-Compose
- [Standalone Quick Start Guide](https://milvus.io/docs/v2.0.0/install_standalone-docker.md)

- [Cluster Quick Start Guide](https://milvus.io/docs/v2.0.0/install_cluster-docker.md)

> Coming soon.

#### Install with Helm



> Coming soon.

Build from source code
### To start developing Milvus

```bash
# Clone github repository.
$ cd /home/$USER/
$ git clone https://github.com/milvus-io/milvus.git

# Install third-party dependencies.
$ cd /home/$USER/milvus/
$ cd milvus/
$ ./scripts/install_deps.sh

# Compile Milvus standalone.
$ make milvus
# Compile Milvus.
$ make
```



### Install Milvus Cluster

#### Install with Docker-Compose

> Coming soon.

#### Install with Helm

> Coming soon.

Build from source code

```bash
# Clone github repository.
$ cd /home/$USER
$ git clone https://github.com/milvus-io/milvus.git

# Install third-party dependencies.
$ cd milvus
$ ./scripts/install_deps.sh

# Compile Milvus Cluster.
$ make milvus
```
For the full story, see [developer's documentation](https://github.com/milvus-io/milvus/blob/master/DEVELOPMENT.md).

> **IMPORTANT** The master branch is for the development of Milvus v2.0. On March 9th, 2021, we released Milvus v1.0, the first stable version of Milvus with long-term support. To use Milvus v1.0, switch to [branch 1.0](https://github.com/milvus-io/milvus/tree/1.0).

Expand Down
49 changes: 9 additions & 40 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@


<div class="column" align="middle">
<a href="https://internal.zilliz.com:18080/jenkins/job/milvus-ha-ci/job/master/badge/">
<img src="https://internal.zilliz.com:18080/jenkins/job/milvus-ha-ci/job/master/badge/icon" />
<a href="https://ci.milvus.io:18080/jenkins/job/milvus-ha-ci/job/master/badge/">
<img src="https://ci.milvus.io:18080/jenkins/job/milvus-ha-ci/job/master/badge/icon" />
</a>
<a href="https://bestpractices.coreinfrastructure.org/projects/3563">
<img src="https://bestpractices.coreinfrastructure.org/projects/3563/badge" />
Expand Down Expand Up @@ -85,61 +85,30 @@ Milvus 基于 [Apache 2.0 License](https://github.com/milvus-io/milvus/blob/mast



## 安装
## 快速开始

### 安装 Milvus 单机版
### 开始使用 Milvus

#### 使用 Docker-Compose 安装
- [Standalone Quick Start Guide](https://milvus.io/cn/docs/v2.0.0/install_standalone-docker.md)

> 敬请期待。
- [Cluster Quick Start Guide](https://milvus.io/cn/docs/v2.0.0/install_cluster-docker.md)

#### 使用 Helm Chart 安装

> 敬请期待。

从源码编译 Milvus
### 开发 Milvus

```bash
# Clone github repository.
$ cd /home/$USER/
$ git clone https://github.com/milvus-io/milvus.git

# Install third-party dependencies.
$ cd /home/$USER/milvus/
$ cd milvus/
$ ./scripts/install_deps.sh

# Compile Milvus standalone.
$ make milvus
```



### 安装 Milvus 分布式版

#### 使用 Docker-Compose 安装



> 敬请期待。

#### 使用 Helm Chart 安装

> 敬请期待。

从源码编译 Milvus

```bash
# Clone github repository.
$ cd /home/$USER
$ git clone https://github.com/milvus-io/milvus.git

# Install third-party dependencies.
$ cd milvus
$ ./scripts/install_deps.sh

# Compile Milvus Cluster.
$ make milvus
```
获取更多内容,请阅读 [开发者文档](https://github.com/milvus-io/milvus/blob/master/DEVELOPMENT.md)

> **注意** 主分支用于 Milvus v2.0 代码开发。Milvus v1.0 于 2021 年 3 月 9 日发布,是 Milvus 的首个长期支持(LTS)版本。如需使用 Milvus 1.0,请切换至 [1.0 分支](https://github.com/milvus-io/milvus/tree/1.0)。

Expand Down
25 changes: 0 additions & 25 deletions scripts/start.sh

This file was deleted.

25 changes: 25 additions & 0 deletions scripts/start_cluster.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
cd ..

echo "starting rootcoord"
nohup ./bin/milvus run rootcoord > /tmp/rootcoord.log 2>&1 &

echo "starting datacoord"
nohup ./bin/milvus run datacoord > /tmp/datacoord.log 2>&1 &

echo "starting datanode"
nohup ./bin/milvus run datanode > /tmp/datanode.log 2>&1 &

echo "starting proxy"
nohup ./bin/milvus run proxy > /tmp/proxy.log 2>&1 &

echo "starting querycoord"
nohup ./bin/milvus run querycoord > /tmp/querycoord.log 2>&1 &

echo "starting querynode"
nohup ./bin/milvus run querynode > /tmp/querynode.log 2>&1 &

echo "starting indexcoord"
nohup ./bin/milvus run indexcoord > /tmp/indexcoord.log 2>&1 &

echo "starting indexnode"
nohup ./bin/milvus run indexnode > /tmp/indexnode.log 2>&1 &
4 changes: 4 additions & 0 deletions scripts/start_standalone.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
cd ..

echo "starting standalone"
nohup ./bin/milvus run standalone > /tmp/standalone.log 2>&1 &