milvus-io
/
milvus
mirror of https://github.com/milvus-io/milvus.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update doc 

Signed-off-by: zhenshan.cao <zhenshan.cao@zilliz.com>
pull/4973/head^2
zhenshan.cao 2021-01-15 18:03:16 +08:00 committed by yefu.chen
parent 67e6ea8051
commit bfe720bfec
5 changed files with 38 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.devcontainer.json
View File

@ -1,8 +1,8 @@
{ {
"name": "Milvus Distributed Dev Container Definition", "name": "Milvus Distributed Dev Container Definition",
"dockerComposeFile": ["./docker-compose-vscode.yml"], "dockerComposeFile": ["./docker-compose-devcontainer.yml"],
"service": "ubuntu", "service": "ubuntu",
"initializeCommand": "scripts/init_devcontainer.sh && docker-compose -f docker-compose-vscode.yml down || true", "initializeCommand": "scripts/devcontainer.sh && docker-compose -f docker-compose-devcontainer.yml down || true",
"workspaceFolder": "/go/src/github.com/zilliztech/milvus-distributed", "workspaceFolder": "/go/src/github.com/zilliztech/milvus-distributed",
"shutdownAction": "stopCompose", "shutdownAction": "stopCompose",
"extensions": [ "extensions": [

4
.gitignore vendored
View File

@ -11,8 +11,8 @@ pulsar/client-cpp/build/*
# vscode generated files # vscode generated files
.vscode .vscode
docker-compose-vscode.yml docker-compose-devcontainer.yml
docker-compose-vscode.yml.tmp docker-compose-devcontainer.yml.tmp
cmake-build-debug cmake-build-debug
cmake-build-release cmake-build-release

21
docs/developer_guides/chap03_index_service.md
View File

@ -16,7 +16,9 @@ type IndexService interface {
RegisterNode(req RegisterNodeRequest) (RegisterNodeResponse, error) RegisterNode(req RegisterNodeRequest) (RegisterNodeResponse, error)
BuildIndex(req BuildIndexRequest) (BuildIndexResponse, error) BuildIndex(req BuildIndexRequest) (BuildIndexResponse, error)
GetIndexStates(req IndexStatesRequest) (IndexStatesResponse, error) GetIndexStates(req IndexStatesRequest) (IndexStatesResponse, error)
GetIndexFilePaths(req IndexFilePathRequest) (IndexFilePathsResponse, error) GetIndexFilePaths(req IndexFilePathRequest) (IndexFilePathsResponse, error)
NotifyTaskState(TaskStateNotification) error
} }
``` ```
@ -50,6 +52,21 @@ type BuildIndexResponse struct {
} }
``` ```
```go
type BuildIndexCmd struct {
IndexID UniqueID
Req BuildIndexRequest
}
type TaskStateNotification struct {
IndexID UniqueID
IndexState IndexState
IndexFilePaths []string
FailReason string
}
```
* *GetIndexStates* * *GetIndexStates*
```go ```go
@ -95,7 +112,7 @@ type IndexNode interface {
// SetTimeTickChannel(channelName string) error // SetTimeTickChannel(channelName string) error
// SetStatsChannel(channelName string) error // SetStatsChannel(channelName string) error
BuildIndex(req BuildIndexRequest) (BuildIndexResponse, error) BuildIndex(req BuildIndexCmd) error
} }
``` ```

2
docs/developer_guides/chap09_data_service.md
View File

@ -167,7 +167,7 @@ type InsertChannelRequest struct {
```go ```go
type InsertRequest struct { type InsertRequest struct {
RequestBase MsgBase
DbName string DbName string
CollectionName string CollectionName string
PartitionName string PartitionName string

20
scripts/init_devcontainer.sh → scripts/devcontainer.sh
View File

@ -30,14 +30,22 @@ gid=$(id -g)
[ "$uid" -lt 500 ] && uid=501 [ "$uid" -lt 500 ] && uid=501
[ "$gid" -lt 500 ] && gid=$uid [ "$gid" -lt 500 ] && gid=$uid
awk 'c&&c--{sub(/^/,"#")} /# Build devcontainer/{c=5} 1' $ROOT_DIR/docker-compose.yml > $ROOT_DIR/docker-compose-vscode.yml.tmp awk 'c&&c--{sub(/^/,"#")} /# Build devcontainer/{c=5} 1' $ROOT_DIR/docker-compose.yml > $ROOT_DIR/docker-compose-devcontainer.yml.tmp
awk 'c&&c--{sub(/^/,"#")} /# Command/{c=3} 1' $ROOT_DIR/docker-compose-vscode.yml.tmp > $ROOT_DIR/docker-compose-vscode.yml awk 'c&&c--{sub(/^/,"#")} /# Command/{c=3} 1' $ROOT_DIR/docker-compose-devcontainer.yml.tmp > $ROOT_DIR/docker-compose-devcontainer.yml
rm $ROOT_DIR/docker-compose-vscode.yml.tmp rm $ROOT_DIR/docker-compose-devcontainer.yml.tmp
if [ "${machine}" == "Mac" ];then if [ "${machine}" == "Mac" ];then
sed -i '' "s/# user: {{ CURRENT_ID }}/user: \"$uid:$gid\"/g" $ROOT_DIR/docker-compose-vscode.yml sed -i '' "s/# user: {{ CURRENT_ID }}/user: \"$uid:$gid\"/g" $ROOT_DIR/docker-compose-devcontainer.yml
else else
sed -i "s/# user: {{ CURRENT_ID }}/user: \"$uid:$gid\"/g" $ROOT_DIR/docker-compose-vscode.yml sed -i "s/# user: {{ CURRENT_ID }}/user: \"$uid:$gid\"/g" $ROOT_DIR/docker-compose-devcontainer.yml
fi fi
if [ "${1-}" = "up" ]; then
docker-compose -f $ROOT_DIR/docker-compose-devcontainer.yml up -d
fi
if [ "${1-}" = "down" ]; then
docker-compose -f $ROOT_DIR/docker-compose-devcontainer.yml down
fi