OPCT-253: Rename OPCT binary to the new name (#85)

Rename the tool binary name from `openshift-provider-cert*` to `opct`,
removing any reference of OS and ARCH, improving the instructions to use
that 'generic name' in the install section.

https://issues.redhat.com/browse/OPCT-253

docs/dev.md

@@ -171,7 +171,7 @@ If you find issues or changes that are needed to complete, please open a GitHub
 
 1. Export default plugins to local filesystem:
 ```
-openshift-provider-cert assets /tmp
+$ ./opct assets /tmp
 INFO[2022-06-16T15:35:29-06:00] Asset openshift-conformance-validated.yaml saved to /tmp/openshift-conformance-validated.yaml 
 INFO[2022-06-16T15:35:29-06:00] Asset openshift-kube-conformance.yaml saved to /tmp/openshift-kube-conformance.yaml 
 ```
@@ -181,7 +181,7 @@ vi /tmp/openshift-kube-conformance.yaml
 ```
 3. Launch the tool with customized plugin:
 ```
-openshift-provider-cert run --plugin /tmp/openshift-kube-conformance.yaml --plugin /tmp/openshift-conformance-validated.yaml
+./opct run --plugin /tmp/openshift-kube-conformance.yaml --plugin /tmp/openshift-conformance-validated.yaml
 ```
 
 ## Project Documentation  <a name="dev-project-docs"></a>

docs/support-guide.md

@@ -45,7 +45,7 @@ The following conditions require new conformance assets:
 
 ### Install Tools <a name="setup-install"></a>
 
-- Download the [openshift-provider-cert](./user.md#install): OPCT
+- Download the [opct](./user.md#install): OPCT
 - Download the [`omg`](https://github.com/kxr/o-must-gather): tool to analyse Must-gather archive
 ```bash
 pip3 install o-must-gather --user
@@ -97,7 +97,7 @@ Compare the provider results with the baseline:
 > `--baseline` is optional. You must use a trusted baseline results to apply the filters. Otherwise leave it unset.
 
 ```bash
-./openshift-provider-cert-linux-amd64 report \
+./opct report \
     --baseline ./opct_baseline-ocp_4.11.4-platform_none-provider-date_uuid.tar.gz \
     ./<timestamp>_sonobuoy_<uuid>.tar.gz
 ```
@@ -107,7 +107,7 @@ Compare the provider results with the baseline:
 Compare the results and extract the files (option `--save-to`) to the local directory `./results-provider-processed`:
 
 ```bash
-./openshift-provider-cert-linux-amd64 report \
+./opct report \
     --baseline ./opct_baseline-ocp_4.11.4-platform_none-provider-date_uuid.tar.gz \
     --save-to ./results-provider-processed \
     ./<timestamp>_sonobuoy_<uuid>.tar.gz
@@ -120,7 +120,7 @@ This is the expected output:
 ```bash
 (...Header...)
 
-$ $CLI_PATH/openshift-provider-cert-linux-amd64-process0 report 4.12.1-20230131.tar.gz --save-to  ./results-provider-processed
+$ ./opct report 4.12.1-20230131.tar.gz --save-to  ./results-provider-processed
 INFO[2023-02-01T01:26:25-03:00] Processing Plugin 05-openshift-cluster-upgrade... 
 INFO[2023-02-01T01:26:25-03:00] Ignoring Plugin 05-openshift-cluster-upgrade 
 INFO[2023-02-01T01:26:25-03:00] Processing Plugin 10-openshift-kube-conformance... 

docs/user.md

@@ -26,6 +26,7 @@ Table Of Contents:
     - [Check status](#usage-check)
     - [Collect the results](#usage-retrieve)
     - [Check the Results](#usage-results)
+    - [Review the Report](#usage-results)
     - [Submit the Results](#submit-results)
     - [Environment Cleanup](#usage-destroy)
 - [Troubleshooting](#troubleshooting)
@@ -167,6 +168,18 @@ The OPCT is shipped as a single executable binary which can be downloaded from [
 
 The tool can be used from any system with access to API to the OpenShift cluster under test.
 
+```sh
+VERSION=v0.4.1
+BINARY=opct-linux-amd64
+wget -O opct "https://github.com/redhat-openshift-ecosystem/provider-certification-tool/releases/download/${VERSION}/${BINARY}"
+chmod u+x ./opct
+```
+
+!!! warning "OPCT binary"
+    The tool has been renamed from `openshift-provider-cert` to `opct` starting at v0.5.x release.
+
+    The documentation is adapted renaming the references to the older name.
+
 ## Usage <a name="usage"></a>
 
 ### Run conformance tests <a name="usage-run"></a>
@@ -178,10 +191,16 @@ Requirements:
 
 #### Run the default execution mode <a name="usage-run-regular"></a>
 
-- Create and run the validation environment (detaching the terminal/background):
+Create and run the validation environment (detaching the terminal/background):
+
+```sh
+./opct run
+```
+
+Optionally you can watch the execution using `--watch`:
 
 ```sh
-openshift-provider-cert run 
+./opct run --watch
 ```
 
 #### Run the `upgrade` mode <a name="usage-run-upgrade"></a>
@@ -197,7 +216,7 @@ Requirements for running the `upgrade` mode:
 - You must choose the next release of Y-stream (`4.Y+1`) supported by your current release. (See [update graph](https://access.redhat.com/labs/ocpupgradegraph/update_path))
 
 ```sh
-openshift-provider-cert run --mode=upgrade --upgrade-to-image=$(oc adm release info 4.Y+1.Z -o jsonpath={.image})
+./opct run --mode=upgrade --upgrade-to-image=$(oc adm release info 4.Y+1.Z -o jsonpath={.image})
 ```
 
 #### Run with the Disconnected Mirror registry<a name="usage-run-disconnected"></a>
@@ -213,37 +232,30 @@ Requirements for running tests with a disconnected mirror registry:
 
 To run tests such that they use images hosted by the Disconnected Mirror registry:
 
-~~~sh
-openshift-provider-cert run --image-repository ${TARGET_REPO}
-~~~
-
-#### Optional parameters for run <a name="usage-run-optional"></a>
-
-- Create and run the validation environment and keep watching the progress:
 ```sh
-openshift-provider-cert run -w
+./opct run --image-repository ${TARGET_REPO}
 ```
 
 ### Check status <a name="usage-check"></a>
 
 ```sh
-openshift-provider-cert status
+./opct status
 
 # OR Keep watch open until completion
 
-openshift-provider-cert status -w
+./opct status -w
 ```
 
 ### Collect the results <a name="usage-retrieve"></a>
 
 The results must be retrieved from the OpenShift cluster under test using:
 
 ```sh
-openshift-provider-cert retrieve
+./opct retrieve
 
 # OR save to the target directory
 
-openshift-provider-cert retrieve ./destination-dir/
+./opct retrieve ./destination-dir/
 ```
 
 The file must be saved locally.
@@ -253,7 +265,15 @@ The file must be saved locally.
 You can see a summarized view of the results using:
 
 ```sh
-openshift-provider-cert results <retrieved-archive>.tar.gz
+./opct results <retrieved-archive>.tar.gz
+```
+
+#### Review the report <a name="usage-report"></a>
+
+Review the data generated by report:
+
+```sh
+./opct report <retrieved-archive>.tar.gz
 ```
 
 ### Submit the results archive <a name="submit-results"></a>
@@ -283,7 +303,7 @@ Required files to attach to a NEW support case:
 Once the validation process is complete and you are comfortable with destroying the test environment:
 
 ```sh
-openshift-provider-cert destroy
+./opct destroy
 ```
 
 You will need to destroy the OpenShift cluster under test separately.