Skip to content

Commit

Permalink
OPCT-177: Documentation fixing sections indentation and formatting (#61)
Browse files Browse the repository at this point in the history
Fixes on the User documentation and mkdocs reference for the project
name fixed on
#58
  • Loading branch information
mtulio committed May 18, 2023
1 parent d21dd6a commit 4a2cd50
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# OpenShift Provider Compatibility Tool
# Home

Welcome to the documentation for the OpenShift Provider Compatibility Tool (OPCT)!

Expand Down
10 changes: 5 additions & 5 deletions docs/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,31 +176,31 @@ Requirements:
- You have set the dedicated node
- You have installed OPCT

#### Run the default execution mode (regular) <a name="usage-run-regular"></a>
#### Run the default execution mode <a name="usage-run-regular"></a>

- Create and run the validation environment (detaching the terminal/background):

```sh
openshift-provider-cert run
```

#### Run the 'upgrade' mode <a name="usage-run-upgrade"></a>
#### Run the `upgrade` mode <a name="usage-run-upgrade"></a>

The `upgrade` mode runs the OpenShift cluster updates to the `4.y+1` version, then the regular conformance suites will be executed (Kubernetes and OpenShift). This mode was created to validate the entire update process, and to make sure the target OCP release is validated on the conformance suites.

> Note: If you will submit the results to Red Hat Partner Support, you must have Validated the installation on the initial release using the regular execution. For example, to submit the upgrade tests for 4.11->4.12, you must have submitted the regular tests for 4.11. If you have any questions, ask your Red Hat Partner Manager.
Requirements for running 'upgrade' mode:
Requirements for running the `upgrade` mode:

- You have created the `MachineConfigPool opct`
- You have created the `MachineConfigPool` with name `opct`
- You have installed the OpenShift client locally (`oc`) - or have noted the Image `Digest` of the target release
- 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})
```

### Run Tests with the Disconnected Mirror registry<a name="usage-run-disconnected"></a>
#### Run with the Disconnected Mirror registry<a name="usage-run-disconnected"></a>

Tests are able to be run in a disconnected environment through the use of a mirror registry.

Expand Down
5 changes: 2 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
site_name: OpenShift Provider Certification Tool
site_description: >-
OpenShift Provider Certification Tool | Guide
site_name: OpenShift Provider Compatibility Tool | OPCT
site_description: OpenShift Provider Compatibility Tool
site_url: https://redhat-openshift-ecosystem.github.io/provider-certification-tool
repo_url: https://github.com/redhat-openshift-ecosystem/provider-certification-tool
edit_uri: edit/main/docs/
Expand Down

0 comments on commit 4a2cd50

Please sign in to comment.