Skip to navigation Skip to main content
Red Hat Offline Knowledge Portal
Search Content extracted on: 2026-09-15
  1. Home
  2. Product Documentation
  3. Red Hat OpenShift Dev Spaces
  4. 3.29
  5. How OpenShift Dev Spaces works
  6. What runs on your cluster
What's new
  1. Red Hat OpenShift Dev Spaces release notes
    1. Differences between Red Hat OpenShift Dev Spaces and Eclipse Che
    2. New features and enhancements
    3. Deprecated features
    4. Removed features
    5. Changed features
    6. CVEs
    7. Known issues
    8. Bug fixes
    9. Frequently asked questions
    10. Patch releases
  2. Technology Preview
Discover
  1. What is OpenShift Dev Spaces?
  2. What problems does OpenShift Dev Spaces solve?
  3. Who is OpenShift Dev Spaces for?
  4. When to use OpenShift Dev Spaces
  5. How OpenShift Dev Spaces works
    1. OpenShift Dev Spaces architecture
    2. What runs on your cluster
    3. Operator and lifecycle management
    4. Dev Workspace Operator and workspace pods
    5. Gateway and request routing
    6. Dashboard and workspace management
    7. Server and namespace provisioning
    8. Plug-in registry
    9. What developers get in a workspace
  6. Common user roles and tasks
Get Started
  1. Prepare the platform for developers
    1. Your first week as a platform administrator
    2. Verify the platform works end-to-end
    3. Configure GitHub OAuth for your team
    4. What to configure next
  2. Create your first cloud workspace
    1. Your first-day experience
    2. Open your project in a cloud development environment
    3. Manage your cloud development environments
  3. Connect to your Git repositories
    1. How Git authentication works in cloud development environments
    2. Access private repositories with a personal access token
Plan
  1. Plan deployment resources
    1. Supported platforms and architectures
    2. Size your cluster for OpenShift Dev Spaces
    3. Scalability limits and multi-cluster deployments
    4. Set up the dsc command-line tool
Install
  1. How the installation works
    1. Permissions required for CLI installation
    2. Permissions required for web console installation
  2. Install Red Hat OpenShift Dev Spaces
    1. Deploy using GitOps and Argo CD
    2. Deploy using the CLI
    3. Deploy using the web console
    4. Deploy with GitOps in an air-gapped environment
    5. Deploy in an air-gapped environment
    6. Enable the Ansible sample in a restricted environment
    7. Deploy using an external identity provider
    8. Customize settings during deployment
  3. Confirm OpenShift Dev Spaces is running
  4. Get the dashboard URL to share with your team
  5. Prepare OpenShift Dev Spaces for your team
  6. Remove OpenShift Dev Spaces from your cluster
Upgrade
  1. Plan your upgrade
    1. How the upgrade works
    2. Choose how updates are applied
    3. Pre-upgrade checklist
  2. Approve a pending update in the web console
  3. Upgrade from the command line
    1. Upgrade by using the dsc management tool
    2. Upgrade in an air-gapped environment
  4. Verify the upgrade completed successfully
  5. Fix a duplicate Dev Workspace Operator after a cluster upgrade
Configure
  1. Customize the central configuration
    1. How the central configuration works
    2. Edit the central configuration from the command line
  2. CheCluster Custom Resource fields reference
  3. Dev Workspace Operator custom resources
  4. Connect server components to enterprise systems
    1. Inject files from Secrets and ConfigMaps into containers
    2. Add individual files without replacing directories
    3. Inject environment variables from Secrets and ConfigMaps
    4. Fine-tune the server
  5. Customize the developer dashboard
    1. Customize the dashboard samples for your team
    2. Apply your organization’s branding to the dashboard
  6. Use the server API
  7. Organize workspace namespaces
    1. How workspace namespaces are organized
    2. Set the workspace namespace naming convention
    3. Provision projects in advance
    4. Synchronize resources across user namespaces
    5. Use Kubernetes namespaces instead of OpenShift projects
  8. Set workspace policies for all users
    1. Limit the number of workspaces that a user can keep
    2. Limit the number of workspaces that all users can run simultaneously
    3. Enable users to run multiple workspaces simultaneously
    4. Trust self-signed Git server certificates
    5. Control which nodes run workspaces
    6. Restrict which URLs can create workspaces
    7. Run nested containers in workspaces
  9. Set up network access for workspaces
    1. Restrict network traffic between workspaces
    2. Use a custom hostname for the dashboard
    3. Deploy with a self-signed TLS certificate
    4. Trust custom TLS certificates for external services
    5. Route workspace traffic through a shared ingress controller
    6. Set a custom domain for workspace URLs
    7. Route traffic through a proxy
  10. Control where workspace data is stored
    1. What storage your workspaces need
    2. Use a custom storage provisioner
    3. Choose how workspace data is persisted
    4. Adjust workspace storage capacity
    5. How workspace files persist across restarts
  11. Configure fuse-overlayfs
    1. When to enable fuse-overlayfs
    2. Enable /dev/fuse access on OpenShift 4.14 and earlier
    3. Enable fuse-overlayfs for all workspaces
  12. Back up workspaces
    1. Configure backup with the integrated OpenShift registry
    2. Configure backup with a regular OCI-compatible registry
Secure
  1. Protect your deployment
  2. Control who can access OpenShift Dev Spaces
    1. Grant additional permissions to users
    2. Restrict access to specific users and groups
    3. Remove user data for GDPR compliance
Optimize
  1. What you can optimize in OpenShift Dev Spaces
  2. Speed up workspace starts with image caching
    1. How image caching speeds up workspace starts
    2. Deploy Image Puller from the command line
    3. Deploy Image Puller from the web console
    4. Cache default OpenShift Dev Spaces images on all nodes
    5. Cache your organization’s custom images
    6. Cache additional images for faster starts
    7. Review the default images cached by Image Puller
  3. Scale the platform automatically
    1. Scale OpenShift Dev Spaces for high availability
    2. Prevent workspace failures during node scaling
  4. Verify workspace performance after optimization
    1. Check replica counts, image cache, and workspace startup
Develop
  1. What development tools you can configure
  2. Choose and configure your IDE
    1. IDEs in Cloud Development Environments
    2. Connect JetBrains IntelliJ IDEA Ultimate Edition to a new Dev Spaces workspace
    3. Connect JetBrains IntelliJ IDEA Ultimate Edition to an existing Dev Spaces workspace
    4. Connect JetBrains Toolbox to an OpenShift Dev Spaces workspace
    5. JetBrains Gateway plugin compatibility matrix
    6. Automate installation of VS Code extensions at workspace startup
    7. Define a common IDE
    8. Parameters for che-editor.yaml
  3. Use AI coding assistants
    1. AI assistants in Cloud Development Environments
    2. Configure an AI provider API key
    3. Change the AI tool on a workspace
    4. Set up GitHub Copilot Chat
  4. What you can do in a Cloud Development Environment
  5. Standardize workspace environments
    1. Devfile in OpenShift Dev Spaces
    2. What you can customize in a Cloud Development Environment
  6. Manage credentials and configurations in workspaces
    1. How credentials and configurations work in workspaces
    2. Mount Secrets
    3. Create an image pull Secret with oc
    4. Create an image pull Secret from a .dockercfg file
    5. Create an image pull Secret from a config.json file
    6. Mount ConfigMaps
    7. Mount Git configuration
    8. Mount SSH configuration
  7. Build and run containers in workspaces
    1. How fuse-overlayfs works in Cloud Development Environments
    2. Access /dev/fuse in workspace containers
    3. Enable fuse-overlayfs with a ConfigMap
    4. How kubedock works
    5. Enable kubedock in a workspace
    6. Use Kubedock in a workspace
  8. Collaborate with your team
    1. Add a factory badge for first-time contributors
    2. Review pull and merge requests
    3. Try in Web IDE GitHub action
    4. Add the action to a GitHub repository workflow
  9. Persist and restore workspace data
    1. Persistent storage for workspaces
    2. Request persistent storage in a devfile
    3. Request persistent storage in a PVC
    4. View backups in the dashboard
    5. Restore a workspace from a backup
  10. Share preconfigured workspace links with your team
    1. URL parameter concatenation
    2. URL parameter for the IDE
    3. URL parameter for the IDE image
    4. URL parameter for starting duplicate workspaces
    5. URL parameter for the existing workspace name
    6. URL parameter for the devfile file name
    7. URL parameter for the devfile file path
    8. URL parameter for the workspace storage
    9. URL parameter for additional remotes
    10. URL parameter for a container image
    11. URL parameter for a memory limit
    12. URL parameter for a CPU limit
    13. URL parameter for the AI provider
    14. Start a cloud development environment from a raw devfile URL
    15. Prevent workspace idling for long-running commands
Observe
  1. What you can observe about OpenShift Dev Spaces
  2. Monitor platform health
    1. What OpenShift Dev Spaces server metrics reveal
    2. Enable OpenShift Dev Spaces server metrics
    3. Verify OpenShift Dev Spaces Server metrics collection with Prometheus
    4. View OpenShift Dev Spaces Server from an OpenShift web console dashboard
    5. What Dev Workspace Operator metrics reveal
    6. Verify Dev Workspace Operator metrics collection with Prometheus
    7. View Dev Workspace Operator metrics from an OpenShift web console dashboard
  3. Configure the Woopra telemetry plugin
  4. Configure logging to isolate issues
    1. How server logging works
    2. Configure log levels
    3. Log HTTP traffic
    4. Collect logs with dsc
Integrate
  1. Connect Git providers with OAuth
    1. Create a GitHub OAuth application for OpenShift Dev Spaces
    2. Create a GitHub App for OpenShift Dev Spaces
    3. Connect OpenShift Dev Spaces to your GitHub OAuth application
    4. Create a GitLab OAuth application for OpenShift Dev Spaces
    5. Connect OpenShift Dev Spaces to your GitLab OAuth application
    6. Create a Bitbucket Server OAuth 2.0 application for OpenShift Dev Spaces
    7. Connect OpenShift Dev Spaces to your Bitbucket Server OAuth 2.0 application
    8. Create a Bitbucket Cloud OAuth consumer for OpenShift Dev Spaces
    9. Connect OpenShift Dev Spaces to your Bitbucket Cloud OAuth consumer
    10. Create a Bitbucket Server OAuth 1.0 application for OpenShift Dev Spaces
    11. Connect OpenShift Dev Spaces to your Bitbucket Server OAuth 1.0 application
    12. Create a Microsoft Entra ID application for OpenShift Dev Spaces
    13. Connect OpenShift Dev Spaces to your Microsoft Entra ID application
    14. Refresh an expired access token automatically
  2. Manage workspaces with OpenShift tools
    1. How workspaces connect to OpenShift
    2. Use automatic OpenShift token injection
    3. List workspaces from the command line
    4. Create a workspace from the command line
    5. Stop a workspace from the command line
    6. Start a stopped workspace from the command line
    7. Remove a workspace from the command line
    8. How OpenShift Dev Spaces appears in the OpenShift console
    9. Edit application code from the OpenShift Developer Perspective
    10. Access OpenShift Dev Spaces from Red Hat Applications menu
    11. Open the OpenShift web console from OpenShift Dev Spaces
  3. Resolve dependencies in restricted environments
    1. Set up Maven to use your internal registry
    2. Set up Gradle to use your internal registry
    3. Set up npm to use your internal registry
    4. Set up Python to use your internal registry
    5. Set up Go to use your internal registry
    6. Set up NuGet to use your internal registry
Extend
  1. What you can customize in workspace tooling
  2. Choose which editors are available
    1. Add custom editors to the dashboard
    2. Set the default IDE for new workspaces
    3. Hide editors from the dashboard
    4. Restore access to deprecated editors
    5. Host editor binaries internally for air-gapped clusters
  3. Customize the default IDE
    1. Work with multiple projects in one workspace
    2. Grant extensions access to OAuth tokens
    3. Pre-install extensions in every workspace
    4. IDE configuration options you can customize
    5. Apply IDE settings to all workspaces
    6. Control which extensions users can install
  4. Add or remove IDE extensions
    1. How IDE extensions work in workspaces
    2. Use an alternative extension registry
    3. Add or remove extensions in a workspace
    4. Add or remove extensions from the Linux command line
  5. Deploy a private extension registry
    1. Deploy from a prebuilt image
    2. Build a custom extension registry from source
    3. Build the extension registry inside a workspace
    4. Restrict the extension registry to internal traffic
    5. Remove an extension through the registry API
    6. Remove an extension directly from the database
  6. What you can add to your platform
  7. Register AI coding assistants for developers
    1. Register an AI provider
    2. AI provider API key secret reference
    3. Disable AI coding assistants
  8. Build a custom telemetry plugin
    1. How telemetry plugins work
    2. Create a telemetry server
    3. Create a telemetry backend
    4. Implement and test telemetry backend event handlers
    5. Deploy a telemetry plugin
    6. Configure workspaces to load a telemetry plugin
Troubleshoot
  1. When something goes wrong with your workspace
  2. View Cloud Development Environment logs
    1. Cloud Development Environment logs
    2. View workspace logs in CLI
    3. View workspace logs in OpenShift console
  3. Debug a failing workspace
  4. Diagnose slow workspaces
  5. Fix webview loading errors in private browsing
  6. Fix devfile errors
  7. When something goes wrong with the platform
  8. Diagnose workspace startup failures
  9. Diagnose slow Cloud Development Environments
  10. Troubleshoot network problems
  11. Fix OAuth configuration errors
Download PDF
  1. Red Hat Dev Spaces 3.29 PDF Reference

What runs on your cluster

Your cluster runs four OpenShift Dev Spaces server deployments that manage multi-tenancy and workspace lifecycle.

Figure 1. OpenShift Dev Spaces server components interacting with the Dev Workspace operator

Diagram showing OpenShift Dev Spaces server component deployments interacting with the Dev Workspace operator
Related concepts
  • Operator and lifecycle management
  • Gateway and request routing
  • Dashboard and workspace management
  • Server and namespace provisioning
  • Plug-in registry
  • ‹ OpenShift Dev Spaces architecture
  • Operator and lifecycle management ›
Red Hat

CONTENT

  • Product documentation
  • Knowledgebase
  • Errata
  • CVEs
  • Product life cycles
  • Security Data API

HELP

  • Contact Red Hat

APP INFO

  • About
  • Release: v1.2.13 2026-09-15
© 2026 Red Hat
  • End user license agreement