Release Notes and Known Issues
Release Notes and Known Issues for Red Hat CodeReady Workspaces 2.11
Michal Maléř
mmaler@redhat.com
Robert Kratky
rkratky@redhat.com
Fabrice Flore-Thébault
ffloreth@redhat.com
Tereza Stastna
tstastna@redhat.com
Max Leonov
mleonov@redhat.com
devtools-docs@redhat.com
Abstract
Making open source more inclusive
Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright’s message.
Chapter 1. About Red Hat CodeReady Workspaces
Red Hat CodeReady Workspaces is a web-based integrated development environment (IDE). CodeReady Workspaces runs in OpenShift and is well-suited for container-based development.
CodeReady Workspaces provides:
- an enterprise-level cloud developer workspace server,
- a browser-based IDE,
- ready-to-use developer stacks for popular programming languages, frameworks, and Red Hat technologies.
Red Hat CodeReady Workspaces 2.11 is based on Eclipse Che 7.34.
1.1. Supported deployment environments
This section describes the availability and the supported installation methods of CodeReady Workspaces 2.11 on OpenShift Container Platform 4.6, 3.11, and OpenShift Dedicated.
Table 1.1. Supported deployment environments for CodeReady Workspaces 2.11 on OpenShift Container Platform and OpenShift Dedicated
Platform | Architecture | Deployment method |
OpenShift Container Platform 3.11 | AMD64 and Intel 64 (x86_64) |
|
OpenShift Container Platform 4.6 | AMD64 and Intel 64 (x86_64) |
OperatorHub, |
OpenShift Container Platform 4.6 | IBM Z (s390x) |
OperatorHub, |
OpenShift Container Platform 4.6 | IBM Power Systems (ppc64le) |
OperatorHub, |
OpenShift Container Platform 4.8 | AMD64 and Intel 64 (x86_64) |
OperatorHub, |
OpenShift Container Platform 4.8 | IBM Z (s390x) |
OperatorHub, |
OpenShift Container Platform 4.8 | IBM Power Systems (ppc64le) |
OperatorHub, |
OpenShift Dedicated 4.8 | AMD64 and Intel 64 (x86_64) | Add-On |
Support for deploying CodeReady Workspaces on OpenShift Container Platform on IBM Z (s390x) is currently only available as a Technology Preview feature. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For details about the level of support for Technology Preview features, see Technology Preview Features Support Scope.
1.2. Support policy
For Red Hat CodeReady Workspaces 2.11, Red Hat will provide support for deployment, configuration, and use of the product.
CodeReady Workspaces 2.11 has been tested on Chrome version 90.0.4430.72 (Official Build) (64-bit).
Additional resources
1.3. Differences between Eclipse Che and Red Hat CodeReady Workspaces
The main differences between CodeReady Workspaces and Eclipse Che are:
- CodeReady Workspaces is built on RHEL8 to ensure the latest security fixes are included, compared to Alpine distributions that take a longer time to update.
- CodeReady Workspaces uses Red Hat Single Sign-On (RH-SSO) rather than the upstream project Keycloak.
- CodeReady Workspaces provides a smaller supported subset of plug-ins compared to Che. CodeReady Workspaces provides devfiles for working with other Red Hat technologies such as EAP and Fuse.
- CodeReady Workspaces is supported on OpenShift Container Platform and OpenShift Dedicated; Eclipse Che can run on other Kubernetes clusters.
Red Hat provides licensing, packaging, and support. Therefore CodeReady Workspaces is considered a more stable product than the upstream Eclipse Che project.
Chapter 2. Notable enhancements
2.1. The Che-Theia editor displaying the Open Folder and Clone Repository buttons for an empty workspace
Before this update, the Che-Theia editor displayed an empty file explorer when the workspace contained no projects. For the user, it was not obvious how to create a file or clone a repository. With this update, the Che-Theia editor displays the Open Folder and Clone Repository buttons in the file explorer.
Additional resources
2.2. Factory link support for private GitHub repositories through OpenShift OAuth authentication
With this update, the GitHub factory implementation supports reading from a private repository. Users can load a devfile hosted in a private repository. The added support for OpenShift OAuth token authentication allows working with repositories behind an RH-SSO organization.
Additional resources
2.3. Configuring the default images for pre-pulling during CodeReady Workspaces installation using OperatorHub
Before this release, using the Image Puller involved providing a list of images to pre-pull. With this release, when installed with CodeReady Workspaces using OperatorHub, the Image Puller auto-pulls the relevant images. The images to pre-pull are the default images used for workspace startup, including Theia, plugin broker, and sidecar images.
Additional resources
2.4. Upgrade of the Visual Studio extension for Apache Camel K
The Tool-set for the Apache Camel K extension has been upgraded to version 0.0.26.
Additional resources
2.5. List of images to pre-pull updates automatically with each new Red Hat CodeReady Workspaces release
- The list of the images to pre-pull is automatically updated on each Red Hat CodeReady Workspaces update.
This implementation allows having:
- Kubernetes Image Puller to always pull up-to-date images
- Cached images for faster workspace start
Additional resources
2.6. Image Puller support for all image types
With this update, the Image Puller can pre-pull any CodeReady Workspaces image on all the Nodes of an OpenShift cluster. This includes scratch images.
Additional resources
Chapter 3. Bug fixes
3.1. Disabling the GitLab master
branch as the explicit default target branch
Before this update, CodeReady Workspaces could not create a workspace using a factory link to an on-premises GitLab repository without a branch named master
. With this update, the GitLab file reading behavior omits the master
branch name by default, and CodeReady Workspaces can create a factory link to a GitLab repository that has the default branch other than master
.
Additional resources
Chapter 4. Known issues
4.1. Debugging cannot be activated in Go workspaces on IBM Z and IBM Power Systems
On IBM Z and IBM Power Systems, the debugging features cannot be activated in the Go workspace in CodeReady Workspaces 2.11. Delve, the required debugger for the Go programming language, is not available for these platforms. An attempt to activate this feature results in the Failed to continue
error message. This issue has no workaround.
Additional resources
4.2. Language server features are not preinstalled in Go workspaces
Golang based workspaces do not include basic language server features such as code autocompletion.
Workaround
- Run the CodeReady Workspaces instance in a non-restricted environment.
- Install the required module by using the Install button in the IDE dialog box.
Additional resources
4.3. Misleading error message for a workspace failure caused by the mkdir
Pod timeout
A lack of OpenShift Container Platform cluster resources causes a failure. This failure causes a misleading message: Your session has expired. Please, log in to CodeReady Workspaces again to get access to your OpenShift account.
Workaround
- Provide more resources to the OpenShift Container Platform cluster.
Additional resources
4.4. Starting multiple instances of the same task fails
Currently, when you start a task from My workspace multiple times, the task does not end. The IDE displays the loading circle but no check mark (✓). As a result, the IDE cannot start the following task.
Workaround
- Execute a task in the My workspace environment only once.
Additional resources
4.5. Error starting a PHP debug session
Currently, CodeReady Workspaces fails to run a PHP debug session with the following error message: There was an error starting the debug session, check the logs for more details. PHP is a Technology Preview feature. There is currently no workaround for this issue.
Additional resources
4.6. Attempts to clone a workspace from a Quick Add sample result in an error under the single-host
strategy
When using the single-host
strategy for workspace exposure, attempting to clone a workspace from a Quick Add sample results in an error. There is currently no workaround for this issue.
Additional resources
4.7. crwctl
binaries are not supported on IBM Z and IBM Power Systems
The crwctl
binaries do not run on IBM Z and IBM Power Systems. These platforms are available as targets for deploying CodeReady Workspaces.
Workaround
-
Run
crwctl
from a supported platform.
Additional resources
4.8. Workspace creation fails on unstable networks
CodeReady Workspaces might fail to create a workspace when the network is unstable. CodeReady Workspaces displays an error such as the following: Failed to run the workspace: "Waiting for pod 'workspace9fbid1gnx7273d47.maven-545f8c9cf4-hw79f' was interrupted." This issue has no workaround.
Additional resources
4.9. Unsupported devfiles on IBM Z and IBM Power Systems
The following devfiles are not supported on IBM Z and IBM Power Systems:
- EAP for OpenJDK 8
- .Net
- Fuse
- Apache Camel K by Red Hat
Workaround
- Do not use unsupported languages on IBM Z and IBM Power Systems.
Additional resources
4.10. Technology preview support for IBM Z
Support for deploying CodeReady Workspaces on OpenShift Container Platform on IBM Z is available as a Technology Preview feature. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not fully function. Red Hat does not suggest using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
Additional resources
4.11. Error message asking the user to log in again at workspace startup
When starting a workspace, users might receive the following error message: Your session has expired. Please login to Che again to get access to your OpenShift account.
Workaround
- Log in again.
Additional resources
4.12. No delegateCommandHandler error for Java with the JBoss EAP 7.3 devfile
A workspace using Java with the JBoss EAP 7.3 devfile fails with the following error message: No delegateCommandHandler for vscode.java.startDebugSession
. There is no workaround for this issue.
Additional resources
4.13. No display for a task after a networking issue
When a task is running and there is some networking issue, the terminal window is cleared and contains no text. Even when the connection is restored, the terminal remains empty and loading. There is no workaround for this issue.
Additional resources
4.14. The OpenShift Connector plug-in fails to deploy an application in a restricted environment
The OpenShift Connector plug-in fails to deploy because of the inability to access the odo
image in the disconnected environment. There is no workaround for this issue.
Additional resources
4.15. The DEBUG configuration is missing
The DEBUG panel displays No Configurations in the drop-down list because no configurations are loaded.
Workaround
- Refresh the page to display the debug configurations.
Additional resources
4.16. Updating the CodeReady Workspaces instance from the multi-host to the single-host strategy breaks the Create Workspace UI
After patching the CodeReady Workspaces 2.11 instance from multi-host
to single-host
, the Dashboard Create Workspace page displays an incomplete UI with missing icons.
Workaround
- Re-deploy the devfile registry Pod after the update.
Additional resources
4.17. The Python workspace displays the "Python not installed" error message
Currently, the Python workspace displays unexpected dialog boxes, including the following error: Python is not installed. Please download and install Python before using the extension. There is currently no workaround for this issue.
Additional resources
4.18. Java analytic plug-in fails in the Java with JBoss EAP XP 3.0 MicroProfile
sample
The Java analytic plugin doesn’t work with the jboss-eap-quickstart
sample project, used by the JBoss EAP XP 3.0 MicroProfile
devfile.
Additional resources
4.19. Workspace creation fails after upgrading DevWorkspace
Currently, after upgrading DevWorkspace 2.10.1 to 2.11, CodeReady Workspaces fails to create a workspace with the following error: Getting workspace detail data failed. Failed to fetch the workspace <workspace_name>, reason: Could not get exposed endpoints for DevWorkspace: controller not ready to resolve the workspace routing.
Workaround
Execute the following commands: oc delete chemanager -n devworkspace-che --wait
oc delete namespace devworkspace-che
Additional resources
4.20. Namespace restriction for OpenShift Dedicated and ROSA
Don’t deploy CodeReady Workspaces to the openshift-workspaces
namespace on OpenShift Dedicated and ROSA.
Workaround
- Use another namespace when deploying CodeReady Workspaces on OpenShift Dedicated and ROSA.
Additional resources
4.21. Technology preview for deploying CodeReady Workspaces 2.11 with the Dev Workspace engine
Support for deploying CodeReady Workspaces 2.11 with the Dev Workspace engine is available as a Technology Preview feature, for OpenShift Container Platform 4.8. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not suggest using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process.
Known limitations
- Workspaces are not protected from inner OpenShift cluster access.
- When deploying CodeReady Workspaces in a restricted environment, starting workspaces will fail because proxy and untrusted TLS certificates are not supported.
- The volumes needed for plug-ins need to be declared in the workspace devfile.
- Workspaces idling is not supported.
- GitHub, GitLab, Bitbucket OAuth flow to automatically configure users accounts is not supported.
- Clusters with a network policy that isolates namespaces networks are not supported.
- Asynchronous storage mode for workspaces is not supported.
- Selecting the editor from the dashboard is not supported.
Additional resources
4.22. Upstream sample devfiles are not supported
Upstream sample devfiles are designed for Eclipse Che. CodeReady Workspaces doesn’t support these samples. A workspace running with the Dev Workspace engine might fail to start when using an upstream sample devfile.
Workaround
- Use supported Red Hat CodeReady Workspaces sample devfiles.
Additional resources
4.23. The OpenShift Connector plug-in does not allow the creation of a new component on IBM Power Systems
On IBM Power Systems, the list of supported image streams is missing, which causes component creation to fail.
Additional resources
4.24. Uninstalling CodeReady Workspaces fails when the Kubernetes Image Puller is installed
When the Kubernetes Image Puller is installed, uninstalling CodeReady Workspaces fails, meaning:
- The deletion process doesn’t remove the Kubernetes Image Puller finalizer.
-
The
CheCluster
Custom Resource is not empty and can’t be removed.
Workaround
- Disable the Kubernetes Image Puller before uninstalling CodeReady Workspaces.
Additional resources
Chapter 5. Frequently asked questions
- Is it possible to deploy applications to an OpenShift cluster from CodeReady Workspaces?
-
Yes. The user must log in to the OpenShift cluster from their running workspace using
oc login
. - For best performance, what is the recommended storage to use for Persistent Volumes used with CodeReady Workspaces?
- Use block storage.
- Is it possible to deploy more than one CodeReady Workspaces instance on the same cluster?
- It is not recommended. This feature is subject to removal in a future release.
- Is it possible to install CodeReady Workspaces offline (that is, disconnected from the internet)?
- Yes. See Installing CodeReady Workspaces in restricted environments.
- Is it possible to use non-default certificates with CodeReady Workspaces?
- Yes, you can use self-signed or public certificates. See Installing CodeReady Workspaces on OpenShift Container Platform 3.11.
- Is it possible to run multiple workspaces simultaneously?
- Yes. See Configuring the number of workspaces a user can run.
- What specific changes have been implemented for IBM Power Systems?
The memory limit for some plug-ins has been increased, to give Pods sufficient RAM to run.
Table 5.1. Example memory limits differences between IBM Power System and other architectures
Plug-in IBM Power System Other architectures Che-Theia editor
2G
512M
OpenShift connector
2.5G
1.5G