Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 33 additions & 2 deletions modules/administration-guide/pages/devworkspace-operator.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_content-type: ASSEMBLY
:description: {devworkspace} operator
:keywords: administration-guide, workspace operator, devworkspace
:description: {devworkspace} operator overview, version requirements, and validation
:keywords: administration-guide, workspace operator, devworkspace, version requirements, validation
:navtitle: {devworkspace} operator
:page-aliases: .:devworkspace-operator.adoc

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

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.

== {devworkspace} Operator version requirements

{prod-short} requires a minimum version of the {devworkspace} Operator to function correctly. The operator enforces this requirement through two validation gates:

.Validation gates
[cols="1,2,2",options="header"]
|===
| Gate | When it occurs | Behavior

| Webhook validation
| CheCluster CR creation
| 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`

| Reconciler version validation
| CheCluster reconciliation
| 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`
|===

IMPORTANT: The current minimum required {devworkspace} Operator version is 0.38.0. This requirement is validated at runtime rather than through package manager dependencies.

.Verification

To verify the installed {devworkspace} Operator version on OpenShift:

[source,bash,subs="+quotes,+attributes"]
----
{orch-cli} get subscription -A -o json | jq -r '.items[] | select(.spec.package=="devworkspace-operator") | .status.installedCSV'
----

The output shows the installed Cluster Service Version (CSV), for example: `devworkspace-operator.v0.40.0`.

.Custom Resources overview

The following Custom Resource Definitions are provided by the {devworkspace} Operator:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ See link:https://docs.openshift.com/container-platform/{ocp4-ver}/operators/admi
[IMPORTANT]
====
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.

{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.
====
+
[IMPORTANT]
Expand Down
Loading