Skip to content

Commit fca7382

Browse files
committed
docs: Document DevWorkspace Operator version requirements and validation
Add documentation for the runtime version validation mechanism introduced in eclipse-che/che-operator#2076. This includes: - New section in devworkspace-operator.adoc explaining the two-gate validation system (webhook and reconciler) - Minimum version requirement (0.38.0) - Error messages users will encounter - Verification steps for checking installed version - Updated installation procedure to mention version requirement Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com> Signed-off-by: Claude Code <noreply@anthropic.com>
1 parent 08d6347 commit fca7382

2 files changed

Lines changed: 35 additions & 2 deletions

File tree

modules/administration-guide/pages/devworkspace-operator.adoc

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
:_content-type: ASSEMBLY
2-
:description: {devworkspace} operator
3-
:keywords: administration-guide, workspace operator, devworkspace
2+
:description: {devworkspace} operator overview, version requirements, and validation
3+
:keywords: administration-guide, workspace operator, devworkspace, version requirements, validation
44
:navtitle: {devworkspace} operator
55
:page-aliases: .:devworkspace-operator.adoc
66

@@ -23,6 +23,37 @@ A `DevWorkspaceTemplate` is a custom resource that defines a reusable `spec.temp
2323

2424
When a workspace is started, DWO reads the corresponding {devworkspace} CR and creates the necessary resources such as deployments, secrets, configmaps, routes such that at the end a workspace pod representing the development environment defined in the devfile is created.
2525

26+
== {devworkspace} Operator version requirements
27+
28+
{prod-short} requires a minimum version of the {devworkspace} Operator to function correctly. The operator enforces this requirement through two validation gates:
29+
30+
.Validation gates
31+
[cols="1,2,2",options="header"]
32+
|===
33+
| Gate | When it occurs | Behavior
34+
35+
| Webhook validation
36+
| CheCluster CR creation
37+
| Prevents CheCluster creation if the {devworkspace} Operator is not installed. Returns error: `DevWorkspace Operator is not installed. Please install it before creating a CheCluster instance`
38+
39+
| Reconciler version validation
40+
| CheCluster reconciliation
41+
| Blocks reconciliation if the installed {devworkspace} Operator version is below the minimum required version. Logs error and updates CheCluster status with message: `DevWorkspace Operator version <installed-version> is installed, but Eclipse Che requires version <minimum-version> or higher. Please upgrade the DevWorkspace Operator`
42+
|===
43+
44+
IMPORTANT: The current minimum required {devworkspace} Operator version is 0.38.0. This requirement is validated at runtime rather than through package manager dependencies.
45+
46+
.Verification
47+
48+
To verify the installed {devworkspace} Operator version on OpenShift:
49+
50+
[source,bash,subs="+quotes,+attributes"]
51+
----
52+
{orch-cli} get subscription -A -o json | jq -r '.items[] | select(.spec.package=="devworkspace-operator") | .status.installedCSV'
53+
----
54+
55+
The output shows the installed Cluster Service Version (CSV), for example: `devworkspace-operator.v0.40.0`.
56+
2657
.Custom Resources overview
2758

2859
The following Custom Resource Definitions are provided by the {devworkspace} Operator:

modules/administration-guide/pages/proc_installing-che-on-openshift-using-the-web-console.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ See link:https://docs.openshift.com/container-platform/{ocp4-ver}/operators/admi
3232
[IMPORTANT]
3333
====
3434
The {prod} Operator depends on the {devworkspace} Operator. If you install the {prod} Operator manually to a non-default namespace, ensure that the {devworkspace} Operator is also installed in the same namespace. The Operator Lifecycle Manager installs the {devworkspace} Operator as a dependency within the {prod} Operator namespace. If the {devworkspace} Operator is already installed in a different namespace, two conflicting installations can result.
35+
36+
{prod-short} requires {devworkspace} Operator version 0.38.0 or higher. The {prod-short} Operator validates this requirement at runtime and blocks CheCluster creation or reconciliation if the requirement is not met.
3537
====
3638
+
3739
[IMPORTANT]

0 commit comments

Comments
 (0)