Skip to content

Commit

Permalink
Add installation in README (#238)
Browse files Browse the repository at this point in the history
Signed-off-by: zhuwenxing <wenxing.zhu@zilliz.com>
  • Loading branch information
zhuwenxing authored Nov 10, 2023
1 parent 84e72fc commit 69c0905
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,15 @@ Milvus-Backup is a tool that allows users to backup and restore Milvus data. Thi

The Milvus-backup process has negligible impact on the performance of Milvus. Milvus cluster is fully functional and can operate normally while backup and restoration are in progress.

## Installation
* Download binary from [release page](https://github.com/zilliztech/milvus-backup/releases)

* Use [homebrew](https://brew.sh/) to install
```shell
brew install zilliztech/tap/milvus-backup
```


## Compatibility
| Milvus | Milvus-backup |
|:----------------:|:----------------:|
Expand All @@ -19,7 +28,7 @@ In order to use Milvus-Backup, access to Milvus proxy and Minio cluster is requi
> Please ensure that the configuration settings for Minio are accurate. There may be variations in the default value of Minio's configuration depending on how Milvus is deployed, either by docker-compose or k8s.
>
> Please be advised that it is not possible to backup data to a local path. Backup data is stored in Minio or another object storage solution used by your Milvus instance.
> |field|docker-compose |k8s|
> |field|docker-compose |helm|
> |---|---|---|
> |bucketName|a-bucket|milvus-bucket|
> |rootPath|files|file|
Expand Down

0 comments on commit 69c0905

Please sign in to comment.