Commit 3473ba52 authored by Valentin Reis's avatar Valentin Reis

[doc] Readme update.

parent 746cee22
Pipeline #4785 passed with stage
in 12 seconds
...@@ -96,7 +96,10 @@ Available commands: ...@@ -96,7 +96,10 @@ Available commands:
helloworld Test 1: Setup stack and check that a hello world app helloworld Test 1: Setup stack and check that a hello world app
sends message back to cmd. sends message back to cmd.
perfwrapper Test 2: Setup stack and check that argo-perf-wrapper perfwrapper Test 2: Setup stack and check that argo-perf-wrapper
sends at least one progress message up. sends at least one progress message to the daemon.
listen Test 3: Setup stack and check that argo-perf-wrapper
sends at least one progress message to cmd listen
through the daemon.
``` ```
Detailed help: Detailed help:
...@@ -111,13 +114,16 @@ Output: ...@@ -111,13 +114,16 @@ Output:
Usage: argotk.hs helloworld [--application APP] Usage: argotk.hs helloworld [--application APP]
[--container_name ARGO_CONTAINER_UUID] [--container_name ARGO_CONTAINER_UUID]
[--output_dir DIR] [--manifest_directory DIR] [--output_dir DIR] [--manifest_directory DIR]
[--manifest_name FILENAME] [--cmd_out FILENAME] [--manifest_name FILENAME] [--cmd_run_out FILENAME]
[--cmd_err FILENAME] [--daemon_out FILENAME] [--cmd_run_err FILENAME] [--cmd_listen_out FILENAME]
[--cmd_listen_err FILENAME] [--daemon_out FILENAME]
[--daemon_err FILENAME] [--nrm_log FILENAME] [--daemon_err FILENAME] [--nrm_log FILENAME]
[--message_daemon_stdout STRING] [--message_daemon_stdout STRING]
[--message_daemon_stderr STRING] [--message_daemon_stderr STRING]
[--message_cmd_stdout STRING] [--message_cmd_run_stdout STRING]
[--message_cmd_stderr STRING] [--message_cmd_run_stderr STRING]
[--message_cmd_listen_stdout STRING]
[--message_cmd_listen_stderr STRING]
Test 1: Setup stack and check that a hello world app sends message back to Test 1: Setup stack and check that a hello world app sends message back to
cmd. cmd.
...@@ -131,10 +137,16 @@ Available options: ...@@ -131,10 +137,16 @@ Available options:
directory (default: FilePath "/nix/store/9hbj77178wrp2pv8qs6d063afhdymgk2-manifests") directory (default: FilePath "/nix/store/9hbj77178wrp2pv8qs6d063afhdymgk2-manifests")
--manifest_name FILENAME Manifest file basename (relative to --manifest_name FILENAME Manifest file basename (relative to
--manifest_directory) (default: FilePath "basic.json") --manifest_directory) (default: FilePath "basic.json")
--cmd_out FILENAME Output file (relative to --output_dir), application --cmd_run_out FILENAME Output file (relative to --output_dir), "cmd run"
stdout (default: FilePath "cmd_out.log") stdout (default: FilePath "cmd_run_out.log")
--cmd_err FILENAME Output file (relative to --output_dir), application --cmd_run_err FILENAME Output file (relative to --output_dir), "cmd run"
stderr (default: FilePath "cmd_err.log") stderr (default: FilePath "cmd_run_err.log")
--cmd_listen_out FILENAME
Output file (relative to --output_dir), "cmd listen"
stdout (default: FilePath "cmd_listen_out.log")
--cmd_listen_err FILENAME
Output file (relative to --output_dir), "cmd listen"
stderr (default: FilePath "cmd_listen_err.log")
--daemon_out FILENAME Output file (relative to --output_dir), daemon --daemon_out FILENAME Output file (relative to --output_dir), daemon
stdout (default: FilePath "daemon_out.log") stdout (default: FilePath "daemon_out.log")
--daemon_err FILENAME Output file (relative to --output_dir), daemon --daemon_err FILENAME Output file (relative to --output_dir), daemon
...@@ -151,16 +163,26 @@ Available options: ...@@ -151,16 +163,26 @@ Available options:
stdout will be monitored during execution. When stdout will be monitored during execution. When
observed, the stack will be killed and a return code observed, the stack will be killed and a return code
of 0 will be returned. of 0 will be returned.
--message_cmd_stdout STRING --message_cmd_run_stdout STRING
The appearance of this character string in the daemon The appearance of this character string in the cmd
stdout will be monitored during execution. When run stdout will be monitored during execution. When
observed, the stack will be killed and a return code observed, the stack will be killed and a return code
of 0 will be returned. (default: "Hello-Moto") of 0 will be returned. (default: "Hello-Moto")
--message_cmd_stderr STRING --message_cmd_run_stderr STRING
The appearance of this character string in the daemon The appearance of this character string in the cmd
stdout will be monitored during execution. When run stdout will be monitored during execution. When
observed, the stack will be killed and a return code observed, the stack will be killed and a return code
of 0 will be returned. (default: "Hello-Moto") of 0 will be returned. (default: "Hello-Moto")
--message_cmd_listen_stdout STRING
The appearance of this character string in the cmd
listen stdout will be monitored during execution.
When observed, the stack will be killed and a return
code of 0 will be returned.
--message_cmd_listen_stderr STRING
The appearance of this character string in the cmd
listen stdout will be monitored during execution.
When observed, the stack will be killed and a return
code of 0 will be returned.
-h,--help Show this help text -h,--help Show this help text
``` ```
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment