diff --git a/config/samples/k8s/mmsys-test-encode/README.md b/config/samples/k8s/mmsys-test-encode/README.md index c7db411..fcceda7 100644 --- a/config/samples/k8s/mmsys-test-encode/README.md +++ b/config/samples/k8s/mmsys-test-encode/README.md @@ -1,4 +1,4 @@ -# Example for mmsys-test-encode operation +# Example for `mmsys-test-encode` function This example shows task execution of the `mmsys-test-encode` function demonstrating MPEG NBMP task error recovery using event sourcing. The NBMP tasks are created directly without going through the NBMP Workflow API and the full workflow manager. However, the nagare media engine `workflow-manager-helper` is deployed as a sidecar container next to the task container. The `workflow-manager-helper` will read the mounted secret and configure the task using the NBMP Task API. It then monitors the execution status. @@ -8,8 +8,8 @@ The `mmsys-test-encode` function can be configured with the following options: | ----------------------------------------------------------------------- | ------------------------------------------------------------------- | | `mmsys-test-encode.engine.nagare.media/test` | Execution test/mode to use (s. below). (required) | | `mmsys-test-encode.engine.nagare.media/chunk-seconds` | Duration of a chunk for split-merge execution modes. (required) | -| `mmsys-test-encode.engine.nagare.media/max-number-of-simulated-crashes` | Number crashes, i.e. hard terminations, to simulate (defaults to 2) | -| `mmsys-test-encode.engine.nagare.media/simulated-crash-wait-duration` | Time to wait until simulated crash is triggered. (defaults to 120s) | +| `mmsys-test-encode.engine.nagare.media/max-number-of-simulated-crashes` | Number crashes, i.e. hard terminations, to simulate (defaults to 1) | +| `mmsys-test-encode.engine.nagare.media/simulated-crash-wait-duration` | Time to wait until simulated crash is triggered. (defaults to 60s) | The following execution tests/modes exist: @@ -17,9 +17,9 @@ The following execution tests/modes exist: | ---------------------------- | --------------------------------------------------------------------- | | baseline-simple | Simple encode of the whole file. | | baseline-split-merge | Simple split-and-merge encode. The chunks are processes sequentially. | -| test-no-recovery-simple | Encode of the whole file with simulated crashes without recovery. | -| test-no-recovery-split-merge | Split-and-merge encode with simulated crashes without recovery. | -| test-recovery-split-merge | Split-and-merge encode with simulated crashed with recovery. | +| test-no-recovery-simple | Encode of the whole file with simulated crashes and no recovery. | +| test-no-recovery-split-merge | Split-and-merge encode with simulated crashes and no recovery. | +| test-recovery-split-merge | Split-and-merge encode with simulated crashed and recovery. | ## Host environment @@ -94,35 +94,30 @@ In every test case, the output encoding can be accessed at