feat: add OCP version compatibility check

[p-rog]

Summary

• Adds a validate_ocp_version Ansible role that checks the target cluster's OCP version against compatibility metadata defined in pattern-metadata.yaml
• Wires the new role into the existing validate_cluster playbook so it runs automatically during make install
• Patterns without ocp_versions metadata are unaffected — the check is gracefully skipped

How it works

Each pattern can declare an ocp_versions section in pattern-metadata.yaml:

ocp_versions:
  minimum: "4.20"
  unsupported:
    - version: "4.23"
      reason: "Not yet validated — operator catalog and channel availability unconfirmed"

Cluster version	Behavior
Supported (>= minimum, not in unsupported list)	Confirmation message, installation proceeds
Below minimum	Polite warning, installation proceeds
Explicitly unsupported	Hard fail with reason displayed
No ocp_versions in metadata	Silently skipped (backward compatible)

Override the hard fail for testing: SKIP_OCP_VERSION_CHECK=true ./pattern.sh make install

Companion PR

• validatedpatterns/layered-zero-trust — add OCP version compatibility metadata (first pattern to adopt this feature)

Context

This originated from a ZTVP-specific implementation (layered-zero-trust#163) that was closed in favor of a framework-level solution after team discussion. The agreed approach was to use pattern-metadata.yaml for version data and the rhvp.cluster_utils collection for validation logic.

Test plan

• Install a pattern with ocp_versions metadata on a supported OCP version — should show OK
• Install on a version below minimum — should show warning, proceed
• Install on an explicitly unsupported version — should hard fail with reason
• SKIP_OCP_VERSION_CHECK=true — should skip the check entirely
• Install a pattern without ocp_versions in metadata — should skip gracefully

Made with Cursor

[mbaldessari]

Hi @p-rog, thanks for the PR, nice work! Can we extend the schema for pattern-metadata yaml here https://github.com/validatedpatterns/pattern-ui-catalog/blob/main/pattern.schema.json so we have it in the reference place.

Note that right now this code won't run when doing "make install" it will only run when running "make validate-cluster"

You will need to add SKIP_OCP_VERSION_CHECK to your pattern.sh (once this lands we will land it in the https://github.com/validatedpatterns/patternizer/ repo)

[mbaldessari]

Could you also do a s/SKIP_OCP_VERSION_CHECK/DISABLE_OCP_VERSION_CHECK/g since we already use that DISABLE_ prefix for other env vars?

[mlorenzofr]

Good job. I think the implementation is quite good, although one task needs to be removed as it doesn't really make sense since we're comparing a k8s version with an ocp version, which have different versioning

[p-rog]

Hi @p-rog, thanks for the PR, nice work! Can we extend the schema for pattern-metadata yaml here https://github.com/validatedpatterns/pattern-ui-catalog/blob/main/pattern.schema.json so we have it in the reference place.

Sure. Here is PR:
validatedpatterns/pattern-ui-catalog#36

@mbaldessari please review it.

Note that right now this code won't run when doing "make install" it will only run when running "make validate-cluster"

You will need to add SKIP_OCP_VERSION_CHECK to your pattern.sh (once this lands we will land it in the https://github.com/validatedpatterns/patternizer/ repo)

@mbaldessari so, do you think we should update the common and add validate-cluster target in common/Makefile like it's done currently with the validate-prereq? IMHO it can be next improvement and for now we can keep validation by running make validate-cluster. WDYT?

[mhjacks]

The set_fact/rescue bit has to change.

I'm curious what others think of the text box output - I could be persuaded on this point.

The note on changing pattern.sh is a change I think we would make and propogate.

[mbaldessari]

Hi @p-rog, thanks for the PR, nice work! Can we extend the schema for pattern-metadata yaml here https://github.com/validatedpatterns/pattern-ui-catalog/blob/main/pattern.schema.json so we have it in the reference place.

Sure. Here is PR: validatedpatterns/pattern-ui-catalog#36

@mbaldessari please review it.

Note that right now this code won't run when doing "make install" it will only run when running "make validate-cluster"
You will need to add SKIP_OCP_VERSION_CHECK to your pattern.sh (once this lands we will land it in the https://github.com/validatedpatterns/patternizer/ repo)

@mbaldessari so, do you think we should update the common and add validate-cluster target in common/Makefile like it's done currently with the validate-prereq? IMHO it can be next improvement and for now we can keep validation by running make validate-cluster. WDYT?

Let's stick with leaving it in the validated-cluster, maybe some readme (iirc) might need some tweaking here and there since it is not being run by default during install. We can always add it later to the install target

[darkdoc]

Hi @p-rog, thanks for the PR, nice work! Can we extend the schema for pattern-metadata yaml here https://github.com/validatedpatterns/pattern-ui-catalog/blob/main/pattern.schema.json so we have it in the reference place.

Sure. Here is PR: validatedpatterns/pattern-ui-catalog#36

@mbaldessari please review it.

Note that right now this code won't run when doing "make install" it will only run when running "make validate-cluster"
You will need to add SKIP_OCP_VERSION_CHECK to your pattern.sh (once this lands we will land it in the https://github.com/validatedpatterns/patternizer/ repo)

@mbaldessari so, do you think we should update the common and add validate-cluster target in common/Makefile like it's done currently with the validate-prereq? IMHO it can be next improvement and for now we can keep validation by running make validate-cluster. WDYT?

If we need this to run during
./pattern.sh make install
this needs to be added to the operator_deploy playbook (which is called during installation)

- role: validate_ocp_version
around here:

rhvp.cluster_utils/playbooks/operator_deploy.yml

Line 11 in afb8281

- role: validate_cluster # ensure a cluster is connected and has a default storage class

[p-rog]

Hi @p-rog, thanks for the PR, nice work! Can we extend the schema for pattern-metadata yaml here https://github.com/validatedpatterns/pattern-ui-catalog/blob/main/pattern.schema.json so we have it in the reference place.

Sure. Here is PR: validatedpatterns/pattern-ui-catalog#36
@mbaldessari please review it.

Note that right now this code won't run when doing "make install" it will only run when running "make validate-cluster"
You will need to add SKIP_OCP_VERSION_CHECK to your pattern.sh (once this lands we will land it in the https://github.com/validatedpatterns/patternizer/ repo)

@mbaldessari so, do you think we should update the common and add validate-cluster target in common/Makefile like it's done currently with the validate-prereq? IMHO it can be next improvement and for now we can keep validation by running make validate-cluster. WDYT?

If we need this to run during ./pattern.sh make install this needs to be added to the operator_deploy playbook (which is called during installation)

- role: validate_ocp_version around here:

rhvp.cluster_utils/playbooks/operator_deploy.yml

Line 11 in afb8281

- role: validate_cluster # ensure a cluster is connected and has a default storage class

Ah... I missed that. Thanks for the suggestion.
I added it into the last commit.

@mbaldessari @darkdoc PTAL