From 40344ed7ac8522d7df2d6c1db87e2e9961bdb3ba Mon Sep 17 00:00:00 2001 From: Ethan Date: Tue, 28 Nov 2023 16:56:06 -0800 Subject: [PATCH 1/2] Cleaned documentation for industrial data simulator --- samples/industrial-data-simulator/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/industrial-data-simulator/README.md b/samples/industrial-data-simulator/README.md index 7c0d965..a32aea5 100644 --- a/samples/industrial-data-simulator/README.md +++ b/samples/industrial-data-simulator/README.md @@ -30,7 +30,7 @@ docker build ../.. -f Dockerfile -t makocr.azurecr.io/industrial-data-simulator: kubectl apply -f manifest.yml ``` -Industrial Data simulator runs as a pod within the desired cluster using the kubectl run command. The configuration of choice is provided via stdin of the simulator process within the pod, provided in the command above using `--stdin < config.yml`. Alternative names for a configuration file may be used -- the command simply uses stdin piping to provide simulator with an appropriate configuration. +Industrial Data simulator runs as a pod within the desired cluster using the kubectl apply command with the provided manifest file (`./manifest.yml`). The configuration is passed as a config mapping in the kubernetes manifest, and can be altered to produce the desired simulation. See the example YAML configuration below, with comments describing the various configurable fields. From ac28eff6fc516af1c2077323552f78942046fd2a Mon Sep 17 00:00:00 2001 From: Ethan Date: Tue, 28 Nov 2023 16:56:57 -0800 Subject: [PATCH 2/2] Added additional detail --- samples/industrial-data-simulator/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/samples/industrial-data-simulator/README.md b/samples/industrial-data-simulator/README.md index a32aea5..fd641f8 100644 --- a/samples/industrial-data-simulator/README.md +++ b/samples/industrial-data-simulator/README.md @@ -30,7 +30,7 @@ docker build ../.. -f Dockerfile -t makocr.azurecr.io/industrial-data-simulator: kubectl apply -f manifest.yml ``` -Industrial Data simulator runs as a pod within the desired cluster using the kubectl apply command with the provided manifest file (`./manifest.yml`). The configuration is passed as a config mapping in the kubernetes manifest, and can be altered to produce the desired simulation. +Industrial Data simulator runs as a pod within the desired cluster using the kubectl apply command with the provided manifest file (`./manifest.yml`). The configuration is passed as a config mapping in the kubernetes manifest, and can be altered to produce the desired simulation (see configmap at top of manifest file). See the example YAML configuration below, with comments describing the various configurable fields.