From 61b7d45fddea6ecefd2ee9dee0e2306241bd6b2d Mon Sep 17 00:00:00 2001 From: quicksilver Date: Fri, 5 Feb 2021 20:53:54 +0800 Subject: [PATCH] Update entrypoint.md Signed-off-by: quicksilver --- docs/developer_guides/entrypoint.md | 90 ++++++++++++++--------------- 1 file changed, 43 insertions(+), 47 deletions(-) diff --git a/docs/developer_guides/entrypoint.md b/docs/developer_guides/entrypoint.md index d55f8866cf..b5c45c2551 100644 --- a/docs/developer_guides/entrypoint.md +++ b/docs/developer_guides/entrypoint.md @@ -1,58 +1,54 @@ ## Entrypoint -Usage: +### Syntax -- Command line arguments +Use the following syntax to run `milvus-distributed` commands from your terminal window: - - ```shell - $ ./milvus-distributed --help - usage: main [] - - Milvus - - Flags: - --help Show context-sensitive help (also try --help-long and --help-man). - -m, --master Run master service - -M, --msgstream-service Run msgstream service - -p, --proxy-service Run proxy service - -P, --proxy-node Run proxy node - -q, --query-service Run query service - -Q, --query-node Run query node - -d, --data-service Run data service - -D, --data-node Run data node - -i, --index-service Run index service - -I, --index-node Run index node - - - # Startup master and proxy in a container - $ ./milvus-distributed --master --proxy - ``` +```shell +milvus-distributed [command] [server type] [flags] +``` -- environment variables +Example: - - ``` - $ export ENABLE_MASTER=1 - $ export ENABLE_PROXY=1 - $ ./milvus-distributed - ``` +```bash +$ MILVUS_CONF_PATH=/path/to/milvus-distributed/configs milvus-distributed run master +``` - - ```shell - $ ENABLE_MASTER=1 ENABLE_PROXY=1 ./milvus-distributed - ``` -- docker-compose +

+where `command`, `server type`, and `flags` are: +

- - ```yaml - milvus-master: - image: milvusdb/milvus-distributed:latest - environment: - - master=1 - - milvus-proxy: - image: milvusdb/milvus-distributed:latest - environment: - - proxy=1 - ``` +`command`: Specifies the operation that you want to perform on server, for example `run`, `status`, `stop` - +`server type`: Specifies the server type, `server type` are: +* `master` +* `msgstream` +* `proxyservice` +* `proxynode` +* `queryservice` +* `querynode` +* `dataservice` +* `datanode` +* `indexservice` +* `indexnode` + +`flags`: Specifies optional flags. For example, you can use the `-f` or `--config` flags to specify the configuration file. + +> Getting help +> You can get help for CLI tool using the `--help` flag, or `-h` for short. +> ```shell +> $ milvus-distributed run master --help +> ``` + + +### Environment + + +The table below lists the environment variables that you can use to configure the `milvus-distributed` tool. + + +| Variable | Description | Default | +| :-----:| :----: | :----: | +| MILVUS_CONF_PATH | Milvus configuration path | `/milvus-distributed/configs` |