You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: Document DevWorkspace Operator version requirements and validation
Add documentation for the DevWorkspace Operator version requirements
introduced in eclipse-che/che-operator#2076, which removes OLM dependency
and implements runtime validation.
Changes:
- Add new section on DevWorkspace Operator version requirements (>= 0.42.0)
- Document installation validation mechanism (API presence check)
- Document version validation mechanism during reconciliation
- Include error messages users may encounter
- Add TODO comment about version validation limitations on non-OLM clusters
- Update metadata to reflect new content
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Signed-off-by: Anatolii Bazko <abazko@redhat.com>
:description: {devworkspace} operator, version requirements, and validation
3
+
:keywords: administration-guide, workspace operator, devworkspace, version requirements, prerequisites
4
4
:navtitle: {devworkspace} operator
5
5
:page-aliases: .:devworkspace-operator.adoc
6
6
@@ -23,6 +23,37 @@ A `DevWorkspaceTemplate` is a custom resource that defines a reusable `spec.temp
23
23
24
24
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.
25
25
26
+
[id="devworkspace-operator-version-requirements"]
27
+
== {devworkspace} Operator version requirements
28
+
29
+
{prod-short} requires the {devworkspace} Operator to be installed on the cluster before {prod-short} can be deployed. {prod-short} validates both the presence and version of the {devworkspace} Operator to ensure compatibility.
30
+
31
+
.Minimum version requirement
32
+
33
+
{prod-short} requires {devworkspace} Operator version *0.42.0* or higher.
34
+
35
+
.Validation mechanisms
36
+
37
+
{prod-short} validates the {devworkspace} Operator installation using two mechanisms:
38
+
39
+
Installation validation::
40
+
When you attempt to create a `CheCluster` custom resource, {prod-short} validates that the {devworkspace} Operator is installed on the cluster by checking for the presence of the `DevWorkspaceOperatorConfig` API. If the {devworkspace} Operator is not installed, the `CheCluster` creation fails with the following error:
41
+
+
42
+
----
43
+
DevWorkspace Operator is not installed. Please install DevWorkspace Operator before installing Eclipse Che
44
+
----
45
+
46
+
Version validation::
47
+
During {prod-short} reconciliation, {prod-short} validates that the installed {devworkspace} Operator version meets the minimum version requirement. If an incompatible version is detected, {prod-short} reports an error indicating the installed version and the required minimum version:
48
+
+
49
+
----
50
+
DevWorkspace Operator version X.Y.Z is installed, but Eclipse Che requires version 0.42.0 or higher. Please upgrade the DevWorkspace Operator
51
+
----
52
+
53
+
// TODO: Version validation mechanism queries OLM Subscriptions, which only works on OLM-based deployments (OpenShift). For Helm/kubectl deployments on vanilla Kubernetes, version validation behavior needs clarification.
54
+
55
+
IMPORTANT: Ensure the {devworkspace} Operator is installed and meets the minimum version requirement before installing {prod-short}.
56
+
26
57
.Custom Resources overview
27
58
28
59
The following Custom Resource Definitions are provided by the {devworkspace} Operator:
0 commit comments