diff options
| author | wangkuan <[email protected]> | 2024-02-22 15:31:58 +0800 |
|---|---|---|
| committer | wangkuan <[email protected]> | 2024-02-22 15:31:58 +0800 |
| commit | 0e93f635739f7143ab729d2ed1d4b71b47140edc (patch) | |
| tree | 076b3ac2a9af11874f1a85d19458cb1942187d6e /docs | |
| parent | 9000b73e460721569d32f207eafaa6104b7f6829 (diff) | |
| parent | f4173b58d6b73b1918226c88576ca2d4a267a734 (diff) | |
Merge remote-tracking branch 'origin/develop' into develop
# Conflicts:
# groot-bootstrap/src/test/java/com/geedgenetworks/bootstrap/main/simple/SimpleJobTest.java
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/develop-guide.md | 6 | ||||
| -rw-r--r-- | docs/user-guide.md | 2 |
2 files changed, 5 insertions, 3 deletions
diff --git a/docs/develop-guide.md b/docs/develop-guide.md index dc8b44f..621616a 100644 --- a/docs/develop-guide.md +++ b/docs/develop-guide.md @@ -43,12 +43,12 @@ When throwing an exception with a hint message and ensure that the exception has ## Design Principles 1. Package structure: `com.geedgenetworks.[module].[sub-module]`. `groot-stream` is the parent module, and other modules are dependent on it. -2. Module naming: `groot-[module]`. e.g. `groot-common`, `groot-core`, `groot-connectors`, `groot-bootstrap`, `groot-example`, etc. +2. Module naming: `groot-[module]`. e.g. `groot-common`, `groot-core`, `groot-connectors`, `groot-bootstrap`, `groot-examples`, etc. 3. For unchecked exception (RuntimeException) within the 'groot-common' module, a global exception handling class named 'GrootRuntimeException' is defined. ## Run a job example -All examples are in module `groot-stream-example`. You can run the example [ running or debugging a job in IDEA]. -e.g. we use `groot-stream-example/src/main/java/com/geedgenetworks/example/InlineToConsoleExample.java` as the example, when you produce some sample data in `Inline` and you could see the result in console. as follows: +All examples are in module `end-to-end-examples`-. You can run the example [ running or debugging a job in IDEA]. +e.g. we use `end-to-end-examples/src/main/java/com/geedgenetworks/example/GrootStreamExample.java` as the example, when you produce some sample data in `Inline` and you could see the result in console. as follows: ```json {"log_id":155652727148914688,"decoded_as":"BASE","recv_time":111,"fqdn_string":"baidu.com","server_ip":"120.233.20.242","additional_field_subdomain":"baidu.com","client_ip":"192.168.0.1"} ``` 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] |