summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordoufenghu <[email protected]>2024-02-22 09:17:39 +0800
committerdoufenghu <[email protected]>2024-02-22 09:17:39 +0800
commit6d3f5c15e8203671a156a3f15167c3435e5a6138 (patch)
treed89bf3970e88c0f013ace22bb8944b77e5cfb00c
parent786091eeb123e09970c456a1e1e26e59a5eaee00 (diff)
[Improve][Docs] Improve the documentation by adding descriptions for encrypting and decrypting parameter.
-rw-r--r--README.md2
-rw-r--r--docs/user-guide.md2
2 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index b99de3a..9a5c51b 100644
--- a/README.md
+++ b/README.md
@@ -75,7 +75,7 @@ FLINK_JOB_MANAGER_ADDRESS=${FLINK_JOB_MANAGER_ADDRESS:-localhost:8081}
YARN_ADDRESS=${YARN_ADDRESS:-yarn-cluster}
```
#### 3. Configure the groot-stream job
-You need to configure the groot-stream job in `config/inline_to_print_template.yaml` file. More information about config please check [config concept](docs/user-guide.md)
+You need to configure the groot-stream job in `config/template/grootstream_job_template.yaml` file. More information about config please check [config concept](docs/user-guide.md)
#### 4. Submit a job to flink engine
Can be started by a daemon with `-d`.
diff --git a/docs/user-guide.md b/docs/user-guide.md
index 5b06a52..fa05547 100644
--- a/docs/user-guide.md
+++ b/docs/user-guide.md
@@ -146,6 +146,8 @@ Used to define job environment configuration information. For more details, you
Usage: start.sh [options]
Options:
--check Whether check config (default: false)
+ --encrypt Show encrypted config file. If config file is palin text, it will be encrypted and printed to the console.
+ --decrypt Show decrypted config file. If config file is encrypted, it will be decrypted and printed to the console.
-c, --config <config file> Config file path, must be specified
-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]