Release Notes and Known Issues

Red Hat CodeReady Workspaces 2.13

Release Notes and Known Issues for Red Hat CodeReady Workspaces 2.13

Michal Maléř

Robert Kratky

Fabrice Flore-Thébault

Tereza Stastna

Red Hat Developer Group Documentation Team

Abstract

Information about new and noteworthy features as well as known issues in Red Hat CodeReady Workspaces 2.13.

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.13 is based on Eclipse Che 7.38.

1.1. Supported deployment environments

This section describes the availability and the supported installation methods of CodeReady Workspaces 2.13 on OpenShift Container Platform 4.9 4.8, 3.11, and OpenShift Dedicated.

Table 1.1. Supported deployment environments for CodeReady Workspaces 2.13 on OpenShift Container Platform and OpenShift Dedicated

Platform

Architecture

Deployment method

OpenShift Container Platform 3.11

AMD64 and Intel 64 (x86_64)

crwctl

OpenShift Container Platform 4.8

AMD64 and Intel 64 (x86_64)

OperatorHub, crwctl

OpenShift Container Platform 4.8

IBM Z (s390x)

OperatorHub, crwctl

OpenShift Container Platform 4.8

IBM Power Systems (ppc64le)

OperatorHub, crwctl

OpenShift Container Platform 4.9

AMD64 and Intel 64 (x86_64)

OperatorHub, crwctl

OpenShift Container Platform 4.9

IBM Z (s390x)

OperatorHub, crwctl

OpenShift Container Platform 4.9

IBM Power Systems (ppc64le)

OperatorHub, crwctl

OpenShift Dedicated 4.9

AMD64 and Intel 64 (x86_64)

Add-on service

Red Hat OpenShift Service on AWS (ROSA)

AMD64 and Intel 64 (x86_64)

Add-on service

Note

Deploying CodeReady Workspaces on OpenShift Container Platform on IBM Z (s390x) is currently 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 suggest using these features in production. Technology Previews provide early access to upcoming product features and enable 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.13, Red Hat will provide support for deployment, configuration, and use of the product.

CodeReady Workspaces 2.13 has been tested on Chrome version 94.0.4606.81 (Official Build) (64-bit).

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. JakartaEE dependencies have replaced JavaEE dependencies

Before this update, CodeReady Workspaces contained JavaEE dependencies. With this update, CodeReady Workspaces contains JakartaEE dependencies.

Additional resources

2.2. Selecting an editor by using a factory link parameter on a CodeReady Workspaces instance with Dev Workspace engine

With this update, on a CodeReady Workspaces instance with Dev Workspace engine, users can specify their choices of an editor with the che-editor factory link parameter. For example, https://codeready-<openshift_deployment_name>.<domain_name>#<repository-url>?che-editor=eclipse/che&#45;theia/latest is to select Che-Theia.

Additional resources

2.3. Standardized configuration for GitLab, GitHub, and Bitbucket

This enhancement standardizes and simplifies configuration of Git hosting services (GitLab, GitHub, and Bitbucket) for CodeReady Workspaces workspaces, with OpenShift secrets and OAuth.

Additional resources

2.4. PostgreSQL upgrade

New CodeReady Workspaces deployments use PostgreSQL 13. Before this update, CodeReady Workspaces deployments were using PostgreSQL 9.6. PostgreSQL 9.6 is deprecated. Migrate deployments created by an earlier version of CodeReady Workspaces. See: Migrating from PostgreSQL 9 to PostgreSQL 13.

Additional resources

2.5. Support alternate devfile path

With this update, when using the Dev Workspace engine, you can specify the devfile path when creating a workspace from a URL. Use the devfilePath parameter. It enables the coexistence of two devfiles in the same repository, to support the version 1 to version 2 migration.

Additional resources

2.6. Synchronization of the CodeReady Workspaces server settings to workspaces using the Dev Workspace engine

Before this update, when using the Dev Workspace engine, CodeReady Workspaces workspaces were missing required configuration settings, such as proxy or self-signed certificates. With this update, the settings stored by the CodeReady Workspaces server are propagated to the workspaces.

Additional resources

2.7. All workspace engines support devfile v2

With this update, CodeReady Workspaces supports creating workspaces from a devfile version 2 on all workspace engines. Before this update, using the Dev Workspace engine was required.

Additional resources

2.8. CodeReady Workspaces workspaces support the Git Large File Storage extension

With this update, CodeReady Workspaces workspaces support the Git Large File Storage (LFS) extension.

Additional resources

2.9. Upgrade of the OpenShift Connector extension for Visual Studio Code

The OpenShift Connector extension for Visual Studio Code has been upgraded to version 0.2.11.

Additional resources

2.10. Fix CodeReady Workspaces operator error when the OpenShift cluster has multiple projects

Before this update, the CodeReady Workspaces operator crashed with an Out Of Memory (OOM) error in OpenShift clusters with multiple projects. With this update, the memory limit is sufficient.

Additional resources

Chapter 3. Bug fixes

3.1. OpenShift Connector no longer supports OpenShift Container Platform 3.11

CodeReady Workspaces includes a version of OpenShift Connector that doesn’t support OpenShift Container Platform 3.11.

To use the OpenShift Connector inside CodeReady Workspaces, consider one of the following options:

  • Keep OpenShift Container Platform 3.11 and CodeReady Workspaces 2.12.
  • Upgrade to OpenShift Container Platform 3.11 and CodeReady Workspaces 2.13.

OpenShift Container Platform 3.11 will become deprecated in June 2022, and will no longer be supported by CodeReady Workspaces after that date.

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.13. 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

  1. Run the CodeReady Workspaces instance in a non-restricted environment.
  2. 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. 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.5. 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.6. 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.7. 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.8. 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.9. 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.10. 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.11. 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.12. 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.13. 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.14. 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.13 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.15. 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.16. 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.17. 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.18. 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

4.19. Technology preview for deploying CodeReady Workspaces 2.13 with the Dev Workspace engine

Support for deploying CodeReady Workspaces 2.13 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 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.

Known limitations

  • When deploying CodeReady Workspaces in a restricted environment, starting workspaces will fail because proxy and untrusted TLS certificates are not supported.
  • GitHub and GitLab OAuth flow to automatically configure users accounts is not supported.
  • Clusters with a network policy that isolates namespaces networks are not supported.
  • Upgrading an instance with the Dev Workspace engine enabled requires manual steps.

Additional resources

4.20. Prometheus doesn’t display metrics when using the tech-preview Operator channel

After deploying the CodeReady Workspaces Operator form the tech-preview Operator channel in the default namespace and creating a CheCluster Custom Resource in the default namespace, the OpenShift Prometheus UI doesn’t display the metrics.

Workaround

  • Use the latest Operator channel.

Additional resources

4.21. Upgrading an instance with the Dev Workspace engine enabled requires manual steps

Upgrading an instance with the Dev Workspace engine enabled requires manual steps.

Support for deploying CodeReady Workspaces 2.13 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 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.

Procedure

  1. Unsubscribe the CodeReady Workspaces Operator from the latest channel.
  2. Remove the Dev Workspace Controller namespace.
  3. Subscribe the CodeReady Workspaces Operator to the tech-preview-latest-all-namespaces channel.

Additional resources

4.22. The Image Puller doesn’t work with the tech-preview-latest-all-namespaces channel

When using OperatorHub to install CodeReady Workspaces with the Dev Workspace engine, the Image Puller can’t be enabled. The Image Puller doesn’t work with the tech-preview-latest-all-namespaces channel

Workaround

  • Fetch the standalone CodeReady Workspaces imagepuller-rhel8 image and use it manually to perform image pulls across the cluster.

Additional resources

4.23. The command Configure Apache Web Server DocumentRoot does not work in the Cake-php sample project on IBM Power

When using the Cake-php sample, the Configure Apache Web Server DocumentRoots task fails with the following error:

error  sed: couldn't open temporary file /etc/httpd/conf/sedSgv1Z4: Permission denied

Additional resources

4.24. The Quarkus sample workspace from tech-preview channel fails to clone Git repositories in a restricted environment

The Quarkus sample workspace from tech-preview channel fails to clone Git repositories in a restricted environment.

Additional resources

4.25. The Red Hat CodeReady Workspaces welcome page may be empty when a workspace starts

The welcome page tab titled "Red Hat CodeReady Workspaces" may at times load with no content.

Workaround

  • Reload the page in your browser.

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-inIBM Power SystemOther architectures

Che-Theia editor

2G

512M

OpenShift connector

2.5G

1.5G

Legal Notice

Copyright © 2022 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.