Release notes and known issues
Release notes and known issues for Red Hat OpenShift Dev Spaces 3.17
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 and JetBrains IntelliJ IDEA Community (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.17 is based on Eclipse Che 7.92.
1.1. Supported platforms Copy linkLink copied to clipboard!
OpenShift Dev Spaces runs on OpenShift 4.12–4.17 on the following CPU architectures:
-
AMD64 and Intel 64 (
x86_64) -
IBM Z (
s390x)
The following CPU architecture requires Openshift 4.13-4.17 to run OpenShift Dev Spaces:
-
IBM Power (
ppc64le)
Additional resources
1.2. Support policy Copy linkLink copied to clipboard!
For Red Hat OpenShift Dev Spaces 3.17, 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. Passphrase configuration for SSH keys Copy linkLink copied to clipboard!
With this release, you can specify a passphrase while adding a new SSH key using the "SSH Keys" tab in the User Preferences.
This feature is a Technology Preview feature, and disabled by default. In order to use this feature, config.enableExperimentalFeatures: true must be set in the DevWorkspaceOperatorConfig Custom Resource.
Passphrase configuration for SSH keys 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
2.2. Restricting the total number of the 'Running' workspaces on a cluster Copy linkLink copied to clipboard!
With this release, you can restrict the total number of the 'Running' workspaces on a cluster using the maxNumberOfRunningWorkspacesPerCluster CheCluster CR property.
Learn more about this feature in the official documentation.
Additional resources
2.3. Specifying the list of the allowed sources based on which CDEs can be started Copy linkLink copied to clipboard!
With this release, you can specify the list of URLs based on which Cloud Development Environments (CDEs) can be initialized using the dedicated optional allowedSources CheCluster CR property:
"devEnvironments": {
"allowedSources": {
"urls": ["url_1", "url_2"]
}
"devEnvironments": {
"allowedSources": {
"urls": ["url_1", "url_2"]
}
When using this property, if a particular URL is not allowed explicitly by the admin, users will not be able to initialize and create CDEs based on this source.
Learn more about this feature in the official documentation.
Additional resources
2.4. Adding an option to deploy operands on specific cluster nodes Copy linkLink copied to clipboard!
With this release, you can deploy operands managed by the operator (dashboard, gateway, plugin-registry etc.) on the specific cluster nodes using the dedicated nodeSelector and tolerations properties CR properties:
dashboard:
deployment:
nodeSelector:
tolerations:
dashboard:
deployment:
nodeSelector:
tolerations:
Additional resources
2.5. Possibility to hide some of the default editors on the User Dashboard Copy linkLink copied to clipboard!
With this release, you can conceal editor definitions. This is useful when an admin wants to hide particular editor(s) from the Dashboard UI, e.g. remove the IntelliJ and have only Visual Studio Code - Open Source visible.
Learn more about the procedure in the official documentation.
Additional resources
2.6. Support devfile endpoint annotations Copy linkLink copied to clipboard!
With this release, you can provide endpoint annotations in the devfile. For example, the following devfile snippet will create an ingress or route with the annotation foo: bar on Cloud Development Environment (CDE) startup:
Additional resources
2.7. Provide a way to set the runtime class for all CDE pods using CheCluster CR Copy linkLink copied to clipboard!
The spec.devEnvironments.runtimeClassName property has been added to the CheCluster CR. This property sets the spec.runtimeClassName for all Cloud Development Environment (CDE) pods. The controller.devfile.io/runtime-class attribute for the CDE has precedence over the CheCluster spec.devEnvironments.runtimeClassName property.
Additional resources
2.8. Ignore the 'FailedScheduling' event by default when starting a CDE Copy linkLink copied to clipboard!
With the release, the FailedScheduling event is the default value for the spec.devEnvironments.ignoredUnrecoverableEvents property. This is beneficial when the cluster has an autoscaler configured. If a Cloud Development Environment (CDE) pod cannot be scheduled on any node causing a FailedScheduling event, the CDE startup will be retried when the new node is provisioned.
Additional resources
Chapter 3. Bug fixes Copy linkLink copied to clipboard!
3.1. Previous CDEs error displayed during restart Copy linkLink copied to clipboard!
Before this release, the error message from the previous start would sometimes be shown after the Cloud Development Environment (CDE) restart which was confusing for the user.
The defect has been fixed in this release.
Additional resources
3.2. Extension 'ms-python.python' CANNOT use API proposal: terminalShellIntegration Copy linkLink copied to clipboard!
Before this release, installing the latest Python extension (v2024.14.0) would fail with the following error message: "Extension 'ms-python.python' CANNOT use API proposal: terminalShellIntegration". With this release, the issue is fixed
Additional resources
3.3. Can not start a workspace using a devfile from an internally hosted Gitlab repository Copy linkLink copied to clipboard!
Before this release, starting a workspace with a devfile from an internally hosted Gitlab repository resulted in a "devfile not found" error message. With this release, the defect has been fixed.
Additional resources
3.4. SSH key invalid when added from the dashboard by pasting the key strings Copy linkLink copied to clipboard!
Previously, pasting SSH keys from the User Preferences page in the Che Dashboard caused an invalid format error when cloning a git repository. This issue has been fixed in this release.
Additional resources
3.5. Missing Podman when a volume is mounted to /home/user/.local Copy linkLink copied to clipboard!
When a persistent volume mount had a mount path of /home/user/.local, podman was missing in the CDE’s Universal Developer Image (UDI) container. This bug has been fixed in the latest UDI version.
Additional resources
3.6. Allow starting existing workspaces even if GitHub is down Copy linkLink copied to clipboard!
Before this release, if GitHub OAuth was configured and GitHub was down, you could not start existing CDEs from this source. The defect has been fixed in this release and existing CDE will be started even if the OAuth provider is down with a dedicated warning message shown during start.
Additional resources
3.7. Dashboard is not available when using the CHE_FORCE_REFRESH_PERSONAL_ACCESS_TOKEN property Copy linkLink copied to clipboard!
Previously there was a known issue affecting workspaces using Microsoft Azure DevOps, Bitbucket or GitHub providers in connection with the CHE_FORCE_REFRESH_PERSONAL_ACCESS_TOKEN property. Every time you started a workspace, a new personal access token (PAT) was added and the previous one was not removed. When there were more than five existing PATs, you were not able to run the workspace, and the Dashboard was not available. The defect has been fixed in this release.
Additional resources
3.8. Opening links doesn’t work in Visual Studio Code - Open Source ("Code - OSS") Copy linkLink copied to clipboard!
In the Visual Studio Code - Open Source ("Code - OSS") editor, clicking on links within welcome pages and project README files had no effect. This defect has been fixed 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!
5.1. Intelij IDEA Community deprecation Copy linkLink copied to clipboard!
With this release, Intelij IDEA Community is deprecated.
Additional resources
Chapter 6. Removed functionalities Copy linkLink copied to clipboard!
None.
Chapter 7. Known issues Copy linkLink copied to clipboard!
7.1. Issues with starting a new workspace from a URL that points to a branch of a repository that doesn’t have a devfile Copy linkLink copied to clipboard!
There is a known issue affecting repositories without a devfile.yaml file. If you start a new workspace from a branch of such repository, the default branch (e.g. 'main') is used for project cloning instead of the expected branch.
Additional resources
7.2. 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.3. FIPS compliance update Copy linkLink copied to clipboard!
There’s a known issue with FIPS compliance that results in certain cryptographic modules not being FIPS-validated. Below is a list of requirements and limitations for using FIPS with OpenShift Dev Spaces:
Required cluster and operator updates
Update your Red Hat OpenShift Container Platform installation to the latest z-stream update for 4.11, 4.12, or 4.13 as appropriate. If you do not already have FIPS enabled, you will need to uninstall and reinstall.
Once the cluster is up and running, install OpenShift Dev Spaces 3.7.1 (3.7-264) and verify that the latest DevWorkspace operator bundle 0.21.2 (0.21-7) or newer is also installed and updated. See https://catalog.redhat.com/software/containers/devworkspace/devworkspace-operator-bundle/60ec9f48744684587e2186a3
Golang compiler in UDI image
The Universal Developer Image (UDI) container includes a golang compiler, which was built without the CGO_ENABLED=1 flag. The check-payload scanner ( https://github.com/openshift/check-payload ) will throw an error, but this can be safely ignored provided that anything you build with this compiler sets the correct flag CGO_ENABLED=1 and does NOT use extldflags -static or -tags no_openssl.
The resulting binaries can be scanned and should pass without error.
Statically linked binaries
You can find statically linked binaries not related to cryptography in these two containers:
- code-rhel8
- idea-rhel8.
As they are not related to cryptography, they do not affect FIPS compliance.
Helm support for FIPS
The UDI container includes the helm binary, which was not compiled with FIPS support. If you are in a FIPS environment do not use helm.
Additional resources
7.4. 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.