Skip to content

Commit 1653268

Browse files
committed
docs/pre-install: added decision graph to user guide
1 parent eec4c8c commit 1653268

File tree

2 files changed

+41
-6
lines changed

2 files changed

+41
-6
lines changed

docs/guides/cluster-validation/index.md

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,8 @@ on your infrastructure as if it were a production environment.
9595
Ensure that each feature of your infrastructure that you plan to
9696
support with OpenShift is configured in the cluster (e.g. Load Balancers, Storage, special hardware).
9797

98+
### OpenShift topologies
99+
98100
OpenShift supports the following topologies:
99101

100102
- Highly available OpenShift Container Platform cluster (**HA**): Three control plane nodes with any number of compute nodes.
@@ -114,15 +116,46 @@ OPCT is tested in the following topologies. Any topology flagged as TBD is not c
114116
or have the expected results for a formal validation process when applying
115117
to Red Hat OpenShift programs for Partners.
116118

119+
### OpenShift Platform Type
120+
117121
OpenShift Platform Type supported by OPCT on Red Hat OpenShift validation program:
118122

119123
| Platform Type | Installation method | Documentation |
120124
| -- | -- | -- |
121-
| `External` | `openshift-install` | [OpenShift Product][ocp-agn] [Providers][ocp-prov] |
122-
| `None`* | Assisted Installer: `User-managed` network mode | [OpenShift Product][ai-none] |
123-
| `External` | Agent Based Installer | [OpenShift Product][abi-external] |
125+
| `External` | `openshift-install` | [OpenShift Product][ocp-agn](1), [Providers Guide][ocp-prov](2) |
126+
| `None`* | Assisted Installer: `User-managed` network mode | [OpenShift Product][ai-none](3) |
127+
| `External` | Agent Based Installer | [OpenShift Product][abi-external](4) |
128+
129+
!!! warning "Platform `None` limitation"
130+
Platform type `None` should be used only when required to install OpenShift cluster with Assisted Installer using `User-Managed` networking mode, otherwise use options with platform type `External`.
131+
132+
```mermaid
133+
%%{init: {"flowchart": {"useMaxWidth": false}}}%%
134+
135+
flowchart TD
136+
Start{Choose Installation Method}
137+
Start --> A{Are you using<br/>Assisted Service?}
124138
125-
*platform type `None` should be used only when required to install OpenShift cluster with Assisted Installer using `User-Managed` networking mode, otherwise use options with platform type `External`.
139+
A -->|Yes| B{Is Connected<br/>Installation?}
140+
A -->|No| C["> Install tool: <b>openhift-install</b></br>> Platform type: <b>External</b></br>> platformName: <b>_CHANGE_ME_</b>"]
141+
142+
C -->CQ{"Are you deploying <b>Cloud Controller Manager (CCM)</b>?"}
143+
144+
B -->|Yes| D1["> Install tool: <b>Assisted Installer</b><br/>> Platform type: <b>None</b> <br/>> Network mode: <b>User-Managed</b><br/><br/>Documentation: OpenShift Product AI(3)"]
145+
B -->|No| D2["> Install tool: <b>Agent-Based Installer</b><br/>> Platform type: <b>External</b></br>> platformName: <b>_CHANGE_ME_</b><br/></br>Docs: OpenShift Product ABI(4)"]
146+
147+
CQ -->|No| E1["Docs:<br/>> OpenShift Agnostic Installation(1)<br/>> Provider Onboarding Guide(2)"]
148+
CQ -->|Yes| E2["> Set <b>cloudControllerManager</b> to <b>External</b><br/>> Create CCM manifests"]
149+
150+
E2 --> E1
151+
```
152+
153+
Documentation Reference:
154+
155+
- 1) [OpenShift Product with Installer][ocp-agn]
156+
- 2) [Providers Guide][ocp-prov]
157+
- 3) [OpenShift Product with AI][ai-none]
158+
- 4) [OpenShift Product with ABI][abi-external]
126159

127160
[ocp-agn]: https://docs.openshift.com/container-platform/latest/installing/installing_platform_agnostic/installing-platform-agnostic.html
128161
[ocp-prov]: https://docs.providers.openshift.org/platform-external/installing/
@@ -135,11 +168,13 @@ OpenShift Platform Type supported by OPCT on Red Hat OpenShift validation progra
135168
leading to failures in platform-specific e2e tests requiring special configuration
136169
or credentials.
137170

171+
### OpenShift And OPCT Versions
172+
138173
The matrix below describes the OpenShift and OPCT versions supported:
139174

140175
| OPCT [version][releases] | OCP tested versions | OPCT Execution mode |
141176
| -- | -- | -- |
142-
| v0.5.x | 4.14-4.18 | regular, upgrade, disconnected |
177+
| v0.5.x | 4.14+ | regular, upgrade, disconnected |
143178
| v0.4.x | 4.10-4.13 | regular, upgrade, disconnected |
144179
| v0.3.x | 4.9-4.12 | regular, upgrade |
145180
| v0.2.x | 4.9-4.11 | regular |

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ nav:
3636
- OPCT Rules: review/rules.md
3737
- Support Guide: guides/support-guide.md
3838
- Troubleshooting: review/troubleshooting.md
39-
- "Devel Guide: Reviewing results with AI Assistant": review/review-assistant.md
39+
- "Reviewing results with AI Assistant": review/review-assistant.md
4040

4141
#
4242
# CLI Reference

0 commit comments

Comments
 (0)