summaryrefslogtreecommitdiff
path: root/docs/user-guide.md
diff options
context:
space:
mode:
authordoufenghu <[email protected]>2024-09-02 23:36:07 +0800
committerdoufenghu <[email protected]>2024-09-02 23:36:07 +0800
commit0d5ce165d30383a4b9b9945b61150d8e8015893d (patch)
treed5e47880963730b170478ad3f7cdab9be024d2c1 /docs/user-guide.md
parenta55399cb95c6408233e84540db482ae5e6131746 (diff)
[Fix][e2e-common] Support user-defined variables via CLI when submitting a job.
Diffstat (limited to 'docs/user-guide.md')
-rw-r--r--docs/user-guide.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/user-guide.md b/docs/user-guide.md
index e35616f..d52cfed 100644
--- a/docs/user-guide.md
+++ b/docs/user-guide.md
@@ -153,7 +153,7 @@ Used to define job environment configuration information. For more details, you
# Command
## Run a job by CLI
-
+Note: When submitting a job via CLI, you can use `-D` parameter to specify flink configuration. For example, `-Dexecution.buffer-timeout.interval=1000` to set the buffer timeout to 1000ms. More details can be found in the official [flink documentation](https://flink.apache.org/).
```bash
Usage: start.sh [options]
Options:
@@ -164,7 +164,7 @@ Options:
-e, --deploy-mode <deploy mode> Deploy mode, only support [run] (default: run)
--target <target> Submitted target type, support [local, remote, yarn-session, yarn-per-job]
-n, --name <name> Job name (default: groot-stream-job)
- -i, --variable <variable> User-defined parameters, eg. -i key=value (default: [])
+ -i, --variable <variable> User-defined variables, eg. -i key=value (default: [])
-h, --help Show help message
-v, --version Show version message