Small Docs update

Author: akrzos

docs/README.md

@@ -2,7 +2,7 @@
 
 | Workload/tooling                                   | Short Description                         | Minimum Requirements                  |
 |:-------------------------------------------------- |:----------------------------------------- | ------------------------------------- |
-| [Tooling](tooling.md)                              | Setup pbench metric tools                 | Cluster-admin, Privileged Containers  |
+| [Tooling](tooling.md)                              | Setup pbench instrumentation tools        | Cluster-admin, Privileged Containers  |
 | [Test](test.md)                                    | Test/Run your workload from ssh Container | Cluster-admin, Privileged Containers  |
 | [Baseline](baseline.md)                            | Baseline metrics capture                  | Tooling job*                          |
 | [Scale](scale.md)                                  | Scales worker nodes                       | Cluster-admin                         |
@@ -14,15 +14,16 @@
 | [Deployments Per Namespace](deployments-per-ns.md) | Maximum Deployments                       | None                                  |
 | [PVCscale](pvscale.md)                             | PVCScale test                             | Working storageclass                  |
 | [Conformance](conformance.md)                      | OCP/Kubernetes e2e tests                  | None                                  |
+
 * Baseline job without a tooled cluster just idles a cluster.  The goal is to capture resource consumption over a period of time to characterize resource requirements thus tooling is required. (For now)
 
 ## Network
 
-| Test                       | Requirement                                 |
-|:-------------------------- |:------------------------------------------- |
-| Pod 2 Pod                  | Labeling Nodes                              |
-| Pod 2 Pod with HostNetwork | Labeling Nodes, Open firewall ports at Host |
-| Service 2 Service          | Labeling Nodes                              |
+| Test                        | Requirement                                 |
+|:--------------------------- |:------------------------------------------- |
+| Pod to Pod                  | Labeling Nodes                              |
+| Pod to Pod with HostNetwork | Labeling Nodes, Open firewall ports at Host |
+| Pod to Service              | Labeling Nodes                              |
 
 ## CI Pass/Fail
 
@@ -35,8 +36,8 @@ Each workload will implement a form of pass/fail criteria in order to flag if th
 | [Baseline](baseline.md)                            | NA                            |
 | [Scale](scale.md)                                  | Yes: Test Duration            |
 | [NodeVertical](nodevertical.md)                    | Yes: Exit Code, Test Duration |
-| [PodVertical](podvertical.md)                      | In Progress                   |
-| [MasterVertical](mastervertical.md)                | In Progress                   |
+| [PodVertical](podvertical.md)                      | Yes: Exit Code, Test Duration |
+| [MasterVertical](mastervertical.md)                | Yes: Exit Code, Test Duration |
 | [HTTP](http.md)                                    | No                            |
 | [Network](network.md)                              | No                            |
 | [Deployments Per Namespace](deployments-per-ns.md) | No                            |

docs/network.md

@@ -81,7 +81,7 @@ Pod image to use for pods that are pbench-uperf pods.
 
 ### NETWORK_TEST_UPERF_SSHD_PORT
 Default: `20000`  
-Port for pbench to communicate via ssh to server/client pods. Typically this port is not blocked by any firewalls when conducting Pod to Pod and Service to Service uperf benchmarks. Pod to Pod with HostNetwork will require that this port be opened in the cloud environment firewall along with the uperf port range.
+Port for pbench to communicate via ssh to server/client pods. Typically this port is not blocked by any firewalls when conducting Pod to Pod and Pod to Service uperf benchmarks. Pod to Pod with HostNetwork will require that this port be opened in the cloud environment firewall along with the uperf port range.
 
 ### NETWORK_TEST_UPERF_PORT_RANGE
 Default: `20010 20109`  
@@ -137,7 +137,7 @@ Enables/disables if the network test will cleanup the project(s) that are create
 
 ## Notes for typical Network testing execution
 
-The recommended way to run the Network test is actually three iterations of the network playbook with the following parameters for each run. The first run would test Pod to Pod, the 2nd - Pod to Pod with HostNetwork, and the 3rd - Service to Service which is the most expected usage inside an OpenShift Cluster (Pod -> Svc IP -> Pod).
+The recommended way to run the Network test is actually three iterations of the network playbook with the following parameters for each run. The first run would test Pod to Pod, the 2nd - Pod to Pod with HostNetwork, and the 3rd - Pod to Service which is the most expected usage inside an OpenShift Cluster (Pod -> Svc IP -> Pod).
 
 ### Suggested Pod to Pod Test Configuration
 
@@ -181,7 +181,7 @@ NETWORK_TEST_CLEANUP=true
 
 Make sure `NETWORK_TEST_UPERF_SSHD_PORT` is enabled in your cloud environment to permit traffic when using HostNetwork. HostNetwork *requires* "AUDIT_WRITE" capability per scc.
 
-### Suggested Service to Service Test Configuration
+### Suggested Pod to Service Test Configuration
 
 ```
 NETWORK_TEST_UPERF_IMAGE="quay.io/openshift-scale/scale-ci-uperf"
@@ -245,7 +245,7 @@ NETWORK_TEST_SAMPLES=1
 NETWORK_TEST_CLEANUP=true
 ```
 
-### Service to Service smoke test
+### Pod to Service smoke test
 
 ```
 NETWORK_TEST_UPERF_IMAGE="quay.io/openshift-scale/scale-ci-uperf"

workloads/files/workload-network-script-cm.yml

@@ -53,8 +53,8 @@ data:
     do
       log "Running Network benchmarks with ${pair_count} pair(s)"
       if [ "${NETWORK_TEST_SERVICE}" == "true" ]; then
-        config_prefix="S2S"
-        PAIR_COUNT=${pair_count} envsubst < /root/workload/s2s-network.yaml.template > /tmp/network.yaml
+        config_prefix="P2S"
+        PAIR_COUNT=${pair_count} envsubst < /root/workload/p2s-network.yaml.template > /tmp/network.yaml
         cp /root/workload/svc-template.yaml /tmp/svc-template.yaml
         # Append required ports to service template
         for i in `seq ${NETWORK_TEST_UPERF_PORT_RANGE}`
@@ -180,7 +180,7 @@ data:
           - NS_VALUE: "client"
           - UPERF_IMAGE: ${NETWORK_TEST_UPERF_IMAGE}
           - UPERF_SSHD_PORT: ${NETWORK_TEST_UPERF_SSHD_PORT}
-  s2s-network.yaml.template: |
+  p2s-network.yaml.template: |
     provider: local
     ClusterLoader:
       cleanup: false