This documentation is for a release that is no longer maintained
See documentation for the latest supported version.Release notes and known issues
Release notes and known issues for Red Hat OpenShift Dev Spaces 3.19
Abstract
Making open source more inclusive Copy linkLink copied to clipboard!
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 OpenShift Dev Spaces Copy linkLink copied to clipboard!
Red Hat OpenShift Dev Spaces provides web-based development environments on Red Hat OpenShift with an enterprise-level setup:
- Cloud Development Environments (CDE) server
- IDEs such as Microsoft Visual Studio Code - Open Source, JetBrains IntelliJ IDEA Community and desktop IntelliJ IDEA Ultimate, PyCharm, WebStorm, RubyMine, and CLion editors as a Technology Preview.
- Containerized environments with popular programming languages, frameworks, and Red Hat technologies
Red Hat OpenShift Dev Spaces is well-suited for container-based development.
Red Hat OpenShift Dev Spaces 3.19 is based on Eclipse Che 7.98.
1.1. Supported platforms Copy linkLink copied to clipboard!
OpenShift Dev Spaces runs on OpenShift 4.14–4.18 on the following CPU architectures:
-
AMD64 and Intel 64 (
x86_64
) -
IBM Z (
s390x
) -
IBM Power (
ppc64le
)
Additional resources
1.2. Support policy Copy linkLink copied to clipboard!
For Red Hat OpenShift Dev Spaces 3.19, Red Hat will provide support for deployment, configuration, and use of the product.
Additional resources
1.3. Differences between Red Hat OpenShift Dev Spaces and Eclipse Che Copy linkLink copied to clipboard!
There are some differences between Red Hat OpenShift Dev Spaces and the upstream project on which it is based, Eclipse Che:
- OpenShift Dev Spaces is supported only on Red Hat OpenShift.
- OpenShift Dev Spaces is based on Red Hat Enterprise Linux and is regularly updated to include the latest security fixes.
- OpenShift Dev Spaces provides getting-started samples supported in the air-gap mode with languages and technologies such as Quarkus, Lombok, NodeJS, Python, DotNet, Golang, and C/C++. Community samples are available at the Devfile registry page.
- OpenShift Dev Spaces uses OpenShift OAuth for user login and management.
Red Hat provides licensing and packaging to ensure enterprise-level support for OpenShift Dev Spaces.
Chapter 2. New features and enhancements Copy linkLink copied to clipboard!
2.1. Ability to apply Visual Studio Code editor configurations from a ConfigMap Copy linkLink copied to clipboard!
With this release, you can apply specific configuration properties to the Visual Studio Code - Open Source ("Code - OSS") editor using a dedicated ConfigMap:
Learn more about this feature in the official documentation.
Additional resources
2.2. UI/UX enhancements of the editor tiles on the User Dashboard Copy linkLink copied to clipboard!
The editor tiles displayed on the User Dashboard, including the license and version information, received a UI/UX enhancement.
Additional resources
2.3. Display the full content of the gitconfig file on the User Dashboard Copy linkLink copied to clipboard!
With this release, you can view the full content of the .gitconfig
file. Access it on the User Preferences Gitconfig tab by clicking Switch to Viewer.
Additional resources
2.4. Detect support for fuse-overlayfs for Universal Developer Image Copy linkLink copied to clipboard!
Starting from this release, fuse-overlayfs will be detected automatically for the default Universal Developer Image.
Additional resources
2.5. Configuring workspace endpoints base domain Copy linkLink copied to clipboard!
With this release, the official documentation for configuring workspace endpoints base domain is available.
Additional resources
2.6. Persistent user home documentation Copy linkLink copied to clipboard!
With this release, the official documentation for persisting the /home/user
directory across workspace restarts is available.
Additional resources
2.7. Configuring proxy setting for https_proxy, http_proxy and no_proxy Copy linkLink copied to clipboard!
The official documentation that explains how to configure proxy settings is available.
Additional resources
2.8. Allow to configure securityContext for the gateway container Copy linkLink copied to clipboard!
Starting from this release, the securityContext
set in the CheCluster
Custom Resource is applied to the Cloud Development Environment’s (CDE) che-gateway
container.
Additional resources
2.9. Mount proxy environment variables to dashboard container Copy linkLink copied to clipboard!
With this release, if there is a proxy configured in the cluster, the proxy configuration is mounted to the che-dashboard container as environment variables: HTTP_PROXY
, HTTPS_PROXY
, and NO_PROXY
.
Additional resources
2.10. JetBrains Gateway available as a Technology Preview feature Copy linkLink copied to clipboard!
With this release, you can use JetBrains Gateway to connect your local JetBrains IDE (IntelliJ IDEA Ultimate, PyCharm, WebStorm, RubyMine, and CLion) to a running Dev Spaces instance.
JetBrains Gateway is a Technology Preview feature only. 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 more information about the support scope of Red Hat Technology Preview features, see Technology Preview Features Support Scope.
Additional resources
Chapter 3. Bug fixes Copy linkLink copied to clipboard!
3.1. Allowlist Kubernetes service in 'no_proxy' environment variable Copy linkLink copied to clipboard!
Starting from this release, there is a dedicated warning message for clusters that are behind a proxy, if you did not add the KUBERNETES_SERVICE_HOST
environment variable to the no_proxylist
environment variable.
Additional resources
3.2. Unexpected warning message while try to start a workspace from a raw devfile Copy linkLink copied to clipboard!
Previously, a sporadic warning message could show up while Cloud Development Environment (CDE) was starting from a raw devfile. The defect has been fixed in this release.
Additional resources
3.3. DevWorkspace 'storage-type' attribute temporarily removed when restarting from local devfile Copy linkLink copied to clipboard!
Previously, the DevWorkspace 'storage-type' attribute was temporarily removed when restarting the Cloud Development Environment (CDE) from the local devfile. The defect has been fixed in this release.
Additional resources
3.4. GitHub authorization does not work properly Copy linkLink copied to clipboard!
Previously, revoking the GitHub token from the dashboard could fail with an "OAuth token for provider GitHub was not found" error message under certain conditions. The defect has been fixed in this release.
Additional resources
3.5. An error appears when accessing the User Preferences Git Services tab Copy linkLink copied to clipboard!
Previously, under certain conditions, a "TypeError: Cannot assign to read only property 0
of object `[objectArray]`" error message would appear when navigating to the User Preferences → Git Services tab. The defect has been fixed in this release.
Additional resources
3.6. Factory from Bitbucket server private repository based on SSH URL has an unexpected warning Copy linkLink copied to clipboard!
Before this release, when you started a Cloud Development Environment (CDE) for a Bitbucket server private repository based on an SSH URL, the start was interrupted with an unexpected warning. The defect has been fixed in this release.
Additional resources
3.7. ServiceAccount token cached incorrectly on the User Dashboard Copy linkLink copied to clipboard!
Previously, ServiceAccount token located at the path /var/run/secrets/kubernetes.io/serviceaccount/token
was cached on the User Dashboard end and was not refreshed properly. The defect has been fixed in this release.
Additional resources
3.8. Automatically restart from local devfile when devfile failed to be resolved at startup for SSH URLs Copy linkLink copied to clipboard!
Regression related to the automatic restart from the local devfile for SSH URLs has been fixed in this release.
Additional resources
3.9. Kubeconfig format corruption after switching clusters and restarting workspace Copy linkLink copied to clipboard!
Kubeconfig format corruption after switching clusters and restarting the Cloud Development Environment (CDE) has been fixed in this release.
Additional resources
3.10. Can not create a workspace using SSH Copy linkLink copied to clipboard!
Previously, there was a "Cannot add property controller.devfile.io/bootstrap-devworkspace, object is not extensible" error when you tried to create a workspace with an SSH URL from the Dev Spaces dashboard. This defect has been fixed in this release.
Additional resources
3.11. Current stow implementation in udi8/9 will break under certain conditions Copy linkLink copied to clipboard!
Previously if devEnvironments.persistUserHome.enabled
and devEnvironments.persistUserHome.disableInitContainer
were both true
, and if there was a file in the /home/user
directory that would cause a stow conflict, the stow command would still run and fail due to the conflict. With this release, UBI and UDI entrypoint automatically add conflicting files into the /home/tooling/.stow-local-ignore
to prevent the stow failure.
Additional resources
3.12. Use current project directory at terminal creation Copy linkLink copied to clipboard!
When creating new terminals in the Visual Studio Code - Open Source ("Code - OSS") editor with the New Terminal (Select a Container) option, the initial directory was not the current project directory (ex. /projects/<project-name>
). This defect has been fixed in this release.
Additional resources
3.13. Outdated Visual Studio Code - Open Source ("CODE - OSS") appears in workspaces created in previous Dev Spaces version Copy linkLink copied to clipboard!
Before this release, there was an issue affecting Visual Studio Code - Open Source ("CODE - OSS") after you upgraded Dev Spaces from version 3.17.0 to 3.18.0. An outdated version of the IDE appeared when you opened a workspace previously created from a sample in Dev Spaces 3.17.0. This issue has been fixed in this release.
Additional resources
3.14. Git user.name and user.email not set up automatically Copy linkLink copied to clipboard!
Before this release, there was an issue affecting the automatic setup of Git user.name
and user.email in the `gitconfig
file after you configured your access token (PAT) or OAuth. If you opened User Dashboard > Gitconfig page after PAT or OAuth configuration, you received the following error message: "Author identity unknown." The issue has been solved in this release.
Additional resources
Chapter 4. Technology Preview Copy linkLink copied to clipboard!
Technology Preview features provide early access to upcoming product innovations, enabling you to test functionality and provide feedback during the development process. However, these features are not fully supported under Red Hat Subscription Level Agreements, may not be functionally complete, and are not intended for production use. As Red Hat considers making future iterations of Technology Preview features generally available, we will attempt to resolve any issues that customers experience when using these features. See: Technology Preview support scope.
None.
Chapter 5. Deprecated functionalities Copy linkLink copied to clipboard!
None.
Chapter 6. Removed functionalities Copy linkLink copied to clipboard!
None.
Chapter 7. Known issues Copy linkLink copied to clipboard!
7.1. Error when starting a workspace in Dev Spaces deployed to OpenShift Platform 4.18 Copy linkLink copied to clipboard!
There is a known issue affecting workspaces in Dev Spaces deployed to OpenShift Platform 4.18. When you start the workspace, the following error message appears: "Error creating DevWorkspace deployment: Container tools has state ImagePullBackOff".
Workaround
- Restart the workspace.
Additional resources
7.2. Workspaces using JetBrains IDEs ignore idling timeouts Copy linkLink copied to clipboard!
There is a known issue with the desktop versions of JetBrains IDEs. Workspaces using these IDEs ignore idling timeouts specified by CheCluster properties such as secondsOfRunBeforeIdling
, and secondsOfInactivityBeforeIdling
. There is currently no workaround available.
Additional resources
7.3. JetBrains editors cause workspace startup failure on IBM Power and IBM Z Copy linkLink copied to clipboard!
There is currently a known issue affecting the use of the desktop versions of JetBrains IDEs with IBM Power, and IBM Z architectures. The downloaded JetBrains IDE binaries are not multi-arch, causing workspace startup to fail. There is currently no workaround available.
Additional resources
7.4. Workspaces created with ubi9-based samples as a tool container fail to start with JetBrains IntelliJ IDEA (desktop) Copy linkLink copied to clipboard!
There’s currently a known issue with starting workspaces created with ubi9-based samples (ubi9-minimal, ubi-init, and ubi9) in the desktop version of JetBrains IntelliJ IDEA. The IDE does not load, causing the start of the workspace to fail after a period of time. Currently, there is no workaround available.
Additional resources
7.5. Error when re-opening a running workspace in JetBrains IntelliJ IDEA (desktop) Copy linkLink copied to clipboard!
There is currently a known issue affecting workspaces running in the desktop version of JetBrains IntelliJ IDEA. If you close the IDE while the workspace is still running, you will receive the following error messages after re-opening the IDE: "There was an error in the connection provider", and "No connection handle was returned". There are multiple workarounds available.
Workaround
- Open the workspace locally using the JetBrains Gateway plugin for Dev Spaces.
- Restart the workspace.
- Restart the computer.
Additional resources
7.6. Non-admin users can’t fetch list of workspaces with the JetBrains Gateway plugin Copy linkLink copied to clipboard!
There is currently a known issue affecting workspaces created by non-admin users and the JetBrains Gateway plugin. If you create workspaces in Dev Spaces as a non-admin user and use the same account to access Dev Spaces locally on your computer through the JetBrains Getaway plugin, the fetched list of workspaces will be empty. There is currently no workaround available.
Additional resources
7.7. Workspaces using JetBrains IntelliJ IDEA editor fail to start in air-gapped environment Copy linkLink copied to clipboard!
There’s currently a known issue affecting workspaces using JetBrains Intellij IDEA in an air-gapped environment. If you choose JetBrains IntelliJ IDEA as your editor and try starting a workspace, the workspace startup will fail. A workaround is available.
Workaround
-
Whitelist JetBrains editor binary CDN host
download-cdn.jetbrains.com
.
Additional resources
7.8. Refresh token mode causes cyclic reload of the workspace start page Copy linkLink copied to clipboard!
There is a known issue when experimental refresh token mode is applied using the CHE_FORCE_REFRESH_PERSONAL_ACCESS_TOKEN
property for the GitHub and Microsoft Azure DevOps OAuth providers. This causes the workspace starts to reload the dashboard cyclically, creating a new personal access token on each page restart. The refresh token mode works correctly for 'GitLab' and 'BitBucket' OAuth providers.
Additional resources
7.9. Debugger does not work in the .NET sample Copy linkLink copied to clipboard!
Currently, the debugger in Microsoft Visual Studio Code - Open Source does not work in the .NET sample.
Workaround
Use a different image from the following sources:
Additional resources
Chapter 8. Frequently asked questions Copy linkLink copied to clipboard!
- Is it possible to deploy applications from OpenShift Dev Spaces to an OpenShift cluster?
- OpenShift user token is automatically injected into workspace containers which makes it possible to run oc CLI commands against OpenShift cluster.
- For best performance, what is the recommended storage to use for Persistent Volumes used with OpenShift Dev Spaces?
- Use block storage.
- Is it possible to deploy more than one OpenShift Dev Spaces instance on the same cluster?
- Only one OpenShift Dev Spaces instance can be deployed per cluster.
- Is it possible to install OpenShift Dev Spaces offline (that is, disconnected from the internet)?
- See Installing Red Hat OpenShift Dev Spaces in restricted environments on OpenShift.
- Is it possible to use non-default certificates with OpenShift Dev Spaces?
- You can use self-signed or public certificates. See Importing untrusted TLS certificates.
- Is it possible to run multiple workspaces simultaneously?
- See Enabling users to run multiple workspaces simultaneously.