Update documentation to match v4 (#201)

stishkin · stas · web-flow · commit f2ec419086cf · 2021-05-20T07:23:13.000-07:00
Co-authored-by: stas &lt;statis@microsoft.com&gt;
diff --git a/cli/samples/dredd/petstore/readme.md b/cli/samples/dredd/petstore/readme.md
@@ -2,6 +2,7 @@
 
 This sample runs [dredd](https://github.com/apiaryio/dredd) on the `petstore` - the basic Open API sample app. `Dredd` is deployed alongside `petstore` service docker container.
 
-You can run the sample by executing `raft.py job create --file dredd.json --poll 10`
+You can run the sample in your RAFT Azure deployment by executing `raft.py job create --file dredd.json --poll 10`.
+You can run the sample in your local docker by executing `raft_local.py job create --file dredd.json --network host`.
 
-When the job reaches the `Created` state it will print a link to Azure storage file share that will contain reports produced by `dredd` and logs from `petstore` service.
+When the job reaches the `Created` state it will print a link to Azure storage file share that will contain reports produced by `dredd` and logs from `petstore` service.
diff --git a/cli/samples/dredd/raft/readme.md b/cli/samples/dredd/raft/readme.md
@@ -2,6 +2,8 @@
 
 This sample runs [dredd](https://github.com/apiaryio/dredd) on the your deployment of the `raft` service.
 
-You can run the sample by executing `python run.py`. The python script extracts your raft endpoint definition from `defaults.json`, patches the `dredd.json` job configuration file with the `raft` service endpoint and executes the job. Since any deployment of the `raft` service requires authentication when calling it's APIs - job configuration file passes `MSAL` as the authentication method. Check the secrets of the keyvault deployed as part of the `raft` service for definition of the service principal that is used by `dredd` to authenticate against raft.
+You can run the sample using your local docker service using `python run.py --local` command.
+
+You can run the sample in your RAFT Azure dpeloyment by executing `python run.py`. The python script extracts your raft endpoint definition from `defaults.json`, patches the `dredd.json` job configuration file with the `raft` service endpoint and executes the job. Since any deployment of the `raft` service requires authentication when calling it's APIs - job configuration file passes `MSAL` as the authentication method. Check the secrets of the keyvault deployed as part of the `raft` service for definition of the service principal that is used by `dredd` to authenticate against raft.
 
 When the job reaches the `Created` state it will print a link to Azure storage file share that will contain reports produced by `dredd`. 
diff --git a/cli/samples/multiple-tools/readme.md b/cli/samples/multiple-tools/readme.md
@@ -1,8 +1,10 @@
 #### multiple-tools
 
-This sample runs all tools supported by `raft`.
+This sample runs all tools supported by `raft`. It runs some of the tools against your Azure RAFT deployment.
 
-You can run the sample by executing `python run.py`. 
+You can run the sample in your local docker service by executing `python run.py --local`, but you have to have RAFT Azure deployment available, since it is going to be used as a service under test.
+
+You can run the sample in your Azure RAFT deployment by executing `python run.py`.
 
 Python script extracts your raft endpoint definition from `defaults.json`, patches `compile.yaml` job configuration file with the `raft` service endpoint and executes the compile job. It also runs `dredd` on `https://petstore.swagger.io` endpoint. Since any deployment of the `raft` service requires authentication when calling it's APIs - `fuzz.json` job configuration file passes `MSAL` as authentication method to `ZAP` and `RESTler` tasks. Check secrets of the keyvault deployed as part of the `raft` service for definition of the service principal that is used by `ZAP` and `RESTler` to authenticate against raft.
 
diff --git a/cli/samples/restler/no-authentication-common-file-share/readme.md b/cli/samples/restler/no-authentication-common-file-share/readme.md
@@ -8,7 +8,10 @@ file share.
 
 The **rootFileshare** is a great way to organize related jobs together. 
 
-You can run the sample by executing `python run.py`. This sample creates three jobs: Compile, Fuzz, Replay. The script pipes output of Compile job into Fuzz by mounting a output file-share from Compile step as an input read-only file-share to Fuzz step. Then Fuzz step output file-share is mounted are read-only file-share to Replay step.
+You can run the sample in your Azure RAFT deployment by executing `python run.py`. 
+You can run the sample in your local docker service by executing `python run.py --local`.
+
+This sample creates three jobs: Compile, Fuzz, Replay. The script pipes output of Compile job into Fuzz by mounting a output file-share from Compile step as an input read-only file-share to Fuzz step. Then Fuzz step output file-share is mounted are read-only file-share to Replay step.
 
 Each step will print Results URL to the console - this is a URL that you can paste in a web browser to access Azure file share produced by the job run. For Compile step the results file-share  will contain RESTler compile step output. For Fuzz step the results file-share contains all RESTler output plus all bugs found by the job. For Replay step file-share contains logs after reproducing all the bugs found by Fuzz step.
 
diff --git a/cli/samples/restler/no-authentication/readme.md b/cli/samples/restler/no-authentication/readme.md
@@ -13,7 +13,10 @@ In the **fuzz.json** file notice that there are two tasks defined. These tasks r
 task has a duration defined which means the task will run no longer than this duration. The `test-fuzz-lean` task, 
 or any RESTler `test` task, should not define a duration.
 
-You can run the sample by executing `python run.py`. This sample creates three jobs: Compile, Fuzz, Replay. The script pipes output of Compile job into Fuzz by mounting a output file-share from Compile step as an input read-only file-share to Fuzz step. Then Fuzz step output file-share is mounted are read-only file-share to Replay step.
+You can run the sample in your Azure RAFT deployment by executing `python run.py`. 
+You can run the sample in your local docker service by executing `python run.py --local`.
+
+This sample creates three jobs: Compile, Fuzz, Replay. The script pipes output of Compile job into Fuzz by mounting a output file-share from Compile step as an input read-only file-share to Fuzz step. Then Fuzz step output file-share is mounted are read-only file-share to Replay step.
 
 Each step will print Results URL to the console - this is a URL that you can paste in a web browser to access Azure file share produced by the job run. For Compile step the results file-share  will contain RESTler compile step output. For Fuzz step the results file-share contains all RESTler output plus all bugs found by the job. For Replay step file-share contains logs after reproducing all the bugs found by Fuzz step.
 
diff --git a/cli/samples/restler/running-60-tasks/readme.md b/cli/samples/restler/running-60-tasks/readme.md
@@ -10,4 +10,5 @@ allows for up to 60 containers to run. In this sample the python script spawns p
 
 This sample shows you how simple it is to create multiple tasks configured on the fly.
 
-You can run the sample by executing `python run.py`.
+You can run the sample in your Azure RAFT deployment by executing `python run.py`. 
+You can run the sample in your local docker service by executing `python run.py --local`.
diff --git a/cli/samples/restler/running-against-raft-common-file-share-yaml/readme.md b/cli/samples/restler/running-against-raft-common-file-share-yaml/readme.md
@@ -2,7 +2,9 @@
 
 This sample runs [RESTler](https://github.com/microsoft/restler-fuzzer) on your RAFT deployment. All configurations are defined as yaml files.
 
-You can run the sample by executing `python run.py`. This sample creates three jobs: Compile, Test and Fuzz. 
+You can run the sample in your Azure RAFT deployment by executing `python run.py`. 
+You can run the sample in your local docker service by executing `python run.py --local`. You still have to have Azure RAFT service deployed, since this is service under test.
+This sample creates three jobs: Compile, Test and Fuzz. 
 The script pipes output of Compile job into Test and then into Fuzz jobs by mounting a output file-share from Compile step as an input read-only file-share to Fuzz step. 
 
 Each step will print Results URL to the console - this is a URL that you can paste in a web browser to access Azure file share produced by the job run. For Compile step the results file-share  will contain RESTler compile step output. For Fuzz step the results file-share contains all RESTler output plus all bugs found by the job. For Replay step file-share contains logs after reproducing all the bugs found by Fuzz step. 
diff --git a/cli/samples/restler/running-against-raft-common-file-share/readme.md b/cli/samples/restler/running-against-raft-common-file-share/readme.md
@@ -2,7 +2,9 @@
 
 This sample runs [RESTler](https://github.com/microsoft/restler-fuzzer) on your RAFT deployment.
 
-You can run the sample by executing `python run.py`. This sample creates three jobs: **Compile**, **Test** and **Fuzz**. 
+You can run the sample in your Azure RAFT deployment by executing `python run.py`. 
+You can run the sample in your local docker service by executing `python run.py --local`. You still have to have Azure RAFT service deployed, since this is service under test.
+This sample creates three jobs: **Compile**, **Test** and **Fuzz**. 
 The script pipes output of **Compile** job into **Test** and then into **Fuzz** jobs by mounting a output file-share from **Compile** step as an input read-only file-share to **Fuzz** step. 
 
 Each step will print Results URL to the console - this is a URL that you can paste in a web browser to access Azure file share produced by the job run. For **Compile** step the results file-share  will contain RESTler compile step output. For **Fuzz** step the results file-share contains all RESTler output plus all bugs found by the job. For **Replay** step file-share contains logs after reproducing all the bugs found by **Fuzz** step. 
diff --git a/cli/samples/restler/running-against-raft/readme.md b/cli/samples/restler/running-against-raft/readme.md
@@ -8,7 +8,9 @@ RAFT service itself using authentication.
 You will notice in the **compile.json** job definition values in the `customerPayload` dictionary. This
 dictionary is given to RESTler and it's values are used as fuzzing values in the REST calls.
 
-You can run the sample by executing `python run.py`. This sample creates three jobs: Compile, Test and Fuzz. 
+You can run the sample in your Azure RAFT deployment by executing `python run.py`. 
+You can run the sample in your local docker service by executing `python run.py --local`. You still have to have Azure RAFT service deployed, since this is service under test.
+This sample creates three jobs: Compile, Test and Fuzz. 
 The script pipes output of Compile job into Test and then into Fuzz jobs by mounting a output file-share from Compile step as an input read-only file-share to Fuzz step. 
 
 Each step will print Results URL to the console - this is a URL that you can paste in a web browser to access Azure file share produced by the job run. For Compile step the results file-share  will contain RESTler compile step output. For Fuzz step the results file-share contains all RESTler output plus all bugs found by the job. For Replay step file-share contains logs after reproducing all the bugs found by Fuzz step. 
diff --git a/cli/samples/restler/self-contained/swagger-petstore/readme.md b/cli/samples/restler/self-contained/swagger-petstore/readme.md
@@ -2,7 +2,10 @@
 
 This sample runs [RESTler](https://github.com/microsoft/restler-fuzzer) on a `petstore` docker container deployed alongside RESTler container.
 
-You can run the sample by executing `python run.py`. This sample creates four jobs: Compile, Test, Fuzz and Reaplay. 
+You can run the sample in your Azure RAFT deployment by executing `python run.py`. 
+You can run the sample in your local docker service by executing `python run.py --local`.
+
+This sample creates four jobs: Compile, Test, Fuzz and Reaplay. 
 The script pipes output of Compile job into Test and then into Fuzz jobs by mounting a output file-share from Compile step as an input read-only file-share to Fuzz step. Output of Fuzz run is used for Replay run. Replay run replays all bugs found by Fuzz step.
 
 Each step will print Results URL to the console - this is a URL that you can paste in a web browser to access Azure file share produced by the job run. For Compile step the results file-share  will contain RESTler compile step output. For Fuzz step the results file-share contains all RESTler output plus all bugs found by the job. For Replay step file-share contains logs after reproducing all the bugs found by Fuzz step. 
diff --git a/cli/samples/restler/self-contained/swagger-petstore3/readme.md b/cli/samples/restler/self-contained/swagger-petstore3/readme.md
@@ -2,7 +2,9 @@
 
 This sample runs [RESTler](https://github.com/microsoft/restler-fuzzer) on a `petstore3` docker container deployed alongside RESTler container.
 
-You can run the sample by executing `python run.py`. This sample creates four jobs: Compile, Test, Fuzz and Reaplay. 
+You can run the sample in your Azure RAFT deployment by executing `python run.py`. 
+You can run the sample in your local docker service by executing `python run.py --local`.
+This sample creates four jobs: Compile, Test, Fuzz and Reaplay. 
 The script pipes output of Compile job into Test and then into Fuzz jobs by mounting a output file-share from Compile step as an input read-only file-share to Fuzz step. Output of Fuzz run is used for Replay run. Replay run replays all bugs found by Fuzz step.
 
 Each step will print Results URL to the console - this is a URL that you can paste in a web browser to access Azure file share produced by the job run. For Compile step the results file-share  will contain RESTler compile step output. For Fuzz step the results file-share contains all RESTler output plus all bugs found by the job. For Replay step file-share contains logs after reproducing all the bugs found by Fuzz step. 
diff --git a/cli/samples/schemathesis/running-against-raft/readme.md b/cli/samples/schemathesis/running-against-raft/readme.md
@@ -9,10 +9,16 @@ created for you.
 The **run.py** script gives an example of how you can substitute your deployment name using the CLI
 so that the job definition can stay generic. 
 
-From the CLI directory run the sample with the command:
-```python
+From the CLI directory to run this sample in you Azure RAFT deployment execute the sample with the command:
+```
 python run.py
 ```
+
+To run this sample in your local docker service. You have to have RAFT Azure service deployed, since this is used as a service under test in this sample.
+```
+python run.py --local
+```
+
 or, using the CLI use (assuming a deployment name of `demo`):
 ```json
 python raft.py job create --file samples/zap/running-against-raft/zap.json --substitute "{\"{defaults.deploymentName}\" : \"demo\"}"
diff --git a/cli/samples/zap/running-against-raft-common-file-share/readme.md b/cli/samples/zap/running-against-raft-common-file-share/readme.md
@@ -4,4 +4,6 @@ In this sample, the job description JSON will cause RAFT to execute ZAP against
 RAFT service itself, defining a common file share called **raft**. This can be helpful
 when you want to collect results from multiple job runs under a single file share. 
 
-You can run the sample by calling `python run.py`.
+You can run the sample in you RAFT Azure deployment by calling `python run.py`.
+
+You can run the sample in your local docker service by calling `python run.py --local`. But you have to have RAFT Azure service deployed, since it is used as a service under test by the sample.
diff --git a/cli/samples/zap/running-against-raft/readme.md b/cli/samples/zap/running-against-raft/readme.md
@@ -11,10 +11,16 @@ The raft-zap.py script gives an example of how you can substitute your deploymen
 so that the job definition can stay generic. 
 
 From the CLI directory run the sample with the command:
-```python
+```
 python run.py
 ```
 or, using the CLI use (assuming a deployment name of `demo`):
 ```json
 python raft.py job create --file samples/zap/running-against-raft/zap.json --substitute "{\"{defa
-ults.deploymentName}\" : \"demo\"}"
+ults.deploymentName}\" : \"demo\"}"
+
+
+You can also run this in your local docker service by running, but you have to have RAFT Azure service deployed, since it is used as a service under test by the sample
+```
+python run.py --local
+```
diff --git a/docs/authentication.md b/docs/authentication.md
diff --git a/docs/schema/authentication.md b/docs/schema/authentication.md
diff --git a/src/AgentUtilities/AgentUtilities/Tests.fsx b/src/AgentUtilities/AgentUtilities/Tests.fsx
