Eclipse Che logo Eclipse Che Documentation
Home Blog Source Code

Documentation

    • Introduction to Che
    • Eclipse Che hosted by Red Hat
  • Plan
    • Calculate Che resource requirements
    • Che scalability
    • Install the chectl management tool
  • User Guide
    • Getting started with Che
      • Starting a workspace from a Git repository URL
        • Optional parameters for the URLs for starting a new workspace
          • URL parameter concatenation
          • URL parameter for the IDE
          • URL parameter for the IDE image
          • URL parameter for starting duplicate workspaces
          • URL parameter for the devfile file name
          • URL parameter for the devfile file path
          • URL parameter for the workspace storage
          • URL parameter for additional remotes
          • URL parameter for a container image
          • URL parameter for a memory limit
          • URL parameter for a CPU limit
          • URL parameter for the existing workspace name
      • Starting a workspace from a raw devfile URL
      • Basic actions you can perform on a workspace
      • Restoring workspaces from backups
        • Restoring a workspace from a backup
        • Viewing backups in the dashboard
      • Authenticating to a Git server from a workspace
      • Using the fuse-overlayfs storage driver for Podman and Buildah
        • Accessing /dev/fuse
        • Enabling fuse-overlayfs with a ConfigMap
      • Running containers with kubedock
      • Prevent workspace idling for long-running commands
    • Using Che in team workflow
      • Badge for first-time contributors
      • Reviewing pull and merge requests
      • Try in Web IDE GitHub action
    • Customizing workspace components
    • Introduction to devfile in Che
    • IDEs in workspaces
      • Microsoft Visual Studio Code - Open Source
      • Connecting Visual Studio Code to a Che workspace
      • Defining a common IDE
    • Using credentials and configurations in workspaces
      • Mounting Secrets
        • Creating image pull Secrets
        • Using a Git-provider access token
      • Mounting ConfigMaps
        • Mounting Git configuration
        • Mounting SSH configuration
      • Enabling artifact repositories in a restricted environment
        • Maven
        • Gradle
        • npm
        • Python
        • Go
        • NuGet
    • Requesting persistent storage for workspaces
    • Integrating with Kubernetes
      • Managing workspaces with Kubernetes APIs
      • Automatic Kubernetes token injection
      • Navigating Che from OpenShift Developer Perspective
      • Navigating OpenShift web console from Che
    • Troubleshooting Che
      • Viewing Che workspaces logs
        • Workspace logs in CLI
        • Workspace logs in OpenShift console
        • Language servers and debug adapters logs in the editor
      • Troubleshooting slow workspaces
      • Troubleshooting network problems
      • Troubleshooting webview loading error
  • Administration Guide
    • Security best practices
    • Preparing the installation
      • Supported platforms
      • Architecture
        • Server components
          • Che operator
          • DevWorkspace operator
          • Gateway
          • User dashboard
          • Che server
          • Devfile registry
          • Plug-in registry
        • User workspaces
    • Install Che
      • Deploy on OpenShift
        • Install Che on OpenShift using CLI
        • Install Che on OpenShift using the web console
        • Install Che on OpenShift with Keycloak as external identity provider
      • Deploy on Kubernetes
        • Install Che on Microsoft Azure
        • Install Che on Amazon Elastic Kubernetes Service
        • Install Che on the virtual Kubernetes cluster
      • Deploy locally
        • Install Che on Red Hat OpenShift Local
        • Install Che on Minikube
        • Install Che on Minikube with Keycloak as the OIDC provider
      • Deploy in a restricted environment
        • Install Che in a restricted environment
      • Find the FQDN
      • Permissions to install Che
        • Permissions for CLI installation
        • Permissions for web console installation
    • Configuring Che
      • Understanding the CheCluster Custom Resource
        • Using chectl to configure the CheCluster Custom Resource during installation
        • Using the CLI to configure the CheCluster Custom Resource
        • CheCluster Custom Resource fields reference
      • Configuring namespaces
        • Configuring namespace name
        • Provisioning namespaces in advance
        • Configuring a user namespace
        • Configuring direct namespace creation on OpenShift
      • Configuring server components
        • Mounting a Secret or a ConfigMap as a file or an environment variable into a Eclipse Che container
        • Advanced configuration options for Che server
      • Configuring autoscaling
        • Configuring number of replicas for a Eclipse Che container
        • Configuring machine autoscaling
      • Configuring workspaces globally
        • Limiting the number of workspaces that a user can keep
        • Limiting the number of workspaces that all users can run simultaneously
        • Enabling users to run multiple workspaces simultaneously
        • Git with self-signed certificates
        • Configuring workspaces nodeSelector
        • Configuring allowed URLs for Cloud Development Environments
        • Enabling container run capabilities
      • Caching images for faster workspace start
        • Installing Kubernetes Image Puller
          • Installing the Kubernetes Image Puller operator on Kubernetes cluster by using CLI
          • Installing Image Puller on OpenShift using CLI
          • Installing Image Puller on OpenShift by using the web console
        • Configuring Kubernetes Image Puller
          • Configuring Image Puller to pre-pull default Che images
          • Configuring Image Puller to pre-pull custom images
          • Configuring Image Puller to pre-pull additional images
        • Retrieving the default list of images for Kubernetes Image Puller
      • Configuring observability
        • The Woopra telemetry plugin
        • Creating a telemetry plugin
          • Configuring server logging
          • Collecting logs using chectl
        • Monitoring the DevWorkspace Operator
        • Monitoring Che Server
      • Configuring networking
        • Configuring network policies
        • Configuring Che hostname
        • Configuring Che with self-signed certificates
        • Importing untrusted TLS certificates to Che
        • Adding labels and annotations
        • Configuring workspace endpoints base domain
        • Configuring proxy
      • Configuring storage
        • Configuring storage classes
        • Configuring the storage strategy
        • Configuring storage sizes
        • Persistent user home
      • Configuring dashboard
        • Configuring getting started samples
        • Configuring editors definitions
        • Show deprecated editors
        • Configuring default editor
        • Concealing editors
        • Configuring editors download urls
        • Customizing OpenShift Eclipse Che branding images
      • Managing identities and authorizations
        • Configuring OAuth for Git providers
          • Configuring OAuth 2.0 for GitHub
          • Configuring OAuth 2.0 for GitLab
          • Configuring OAuth 2.0 for a Bitbucket Server
          • Configuring OAuth 2.0 for the Bitbucket Cloud
          • Configuring OAuth 1.0 for a Bitbucket Server
          • Configuring OAuth 2.0 for Microsoft Azure DevOps Services
        • Configuring cluster roles for Che users
        • Configuring advanced authorization
        • Removing user data in compliance with the GDPR
      • Configuring fuse-overlayfs
        • Enabling access to for OpenShift version older than 4.15
        • Enabling fuse-overlayfs for all workspaces
      • DevWorkspace backup
        • Integrated OpenShift container registry
        • Regular OCI-compatible registry
    • Managing IDE extensions
      • Extensions for Microsoft Visual Studio Code - Open Source
      • Configure the Open VSX registry URL
      • Deploy Open VSX from source
      • Deploy Open VSX from a workspace
      • Configure internal Open VSX access
      • Delete an extension using the Open VSX API
      • Delete an extension from the PostgreSQL database
    • Configuring Visual Studio Code - Open Source ("Code - OSS")
      • Configuring single and multiroot workspaces
      • Configure trusted extensions for Microsoft Visual Studio Code
      • Configure default extensions
      • Manage extension installation with ConfigMap
      • Applying editor configurations
    • Using the Che server API
    • Upgrading Che
      • Upgrading the chectl management tool
      • Specifying the update approval strategy
      • Upgrading Che using the OpenShift web console
      • Upgrading Che using the CLI management tool
      • Upgrading Che in a restricted environment
      • Repairing the DevWorkspace Operator on OpenShift
    • Uninstall Che
    • Extensions
      • OpenShift Connector
        • Features of OpenShift Connector
        • Installing OpenShift Connector in Eclipse Che
        • Authenticating with OpenShift Connector from Eclipse Che
        • Creating Components with OpenShift Connector in Eclipse Che
        • Connecting source code from GitHub to a OpenShift Component
    • Che glossary
Documentation next
  • Documentation
    • next
  • Documentation
  • Administration Guide
  • Preparing the installation
Edit this Page

Preparing the installation

To prepare a Che installation, learn about the Che ecosystem and deployment constraints:

  • Supported platforms

  • Install the chectl management tool

  • Che architecture

  • Calculate Che resource requirements

  • Understanding the CheCluster Custom Resource

Eclipse Foundation | Privacy Policy | Terms of Use | Eclipse Public License | Legal Resources