Eclipse Che logo Eclipse Che Documentation
Home Blog Source Code

Documentation

    • Introduction to Che
      • Architecture overview
    • Eclipse Che hosted by Red Hat
      • Try in Web IDE GitHub action
  • End-user Guide
    • Navigating Che
      • Navigating Che: dashboard
      • Importing certificates to browsers
      • Navigating Che from OpenShift Developer Perspective
    • Che-Theia IDE basics
      • Defining custom commands for Che-Theia
      • Version Control
      • Che-Theia Troubleshooting
      • Differences in Che-Theia Webview in single-host mode and multihost mode
    • Using developer workspaces
      • Creating a workspace from a code sample
      • Creating a workspace from a template devfile
      • Creating a workspace from a remote devfile using the dashboard
      • Creating a workspace from local devfile using chectl
      • Importing the source code of a project into a workspace
      • Configuring a workspace
      • Running a workspace
      • Importing Kubernetes applications into a workspace
      • Remotely accessing workspaces
      • Mounting a secret as a file or an environment variable into a workspace container
      • Authenticating on SCM Server with a personal access token
    • Authoring devfiles
      • Authoring devfiles version 1
      • Authoring a devfile 2.0.0
    • Customizing developer environments
      • What is a Che-Theia plug-in
      • Adding a VS Code extension to a workspace
      • Adding a VS Code extension to the Che plug-ins registry
      • Publishing a VS Code extension
      • Testing a VS Code extension in Che
      • Using alternative IDEs in Che
        • IntelliJ Platform IDEs
          • Building IDE image
          • JetBrains offline activation code
        • Theia-based IDEs
      • Adding tools to Che after creating a workspace
      • Using private container registries
    • Using artifact repositories in a restricted environment
      • Using Maven artifact repositories
      • Using Gradle artifact repositories
      • Using Python artifact repositories
      • Using Go artifact repositories
      • Using NuGet artifact repositories
      • Using npm artifact repositories
    • Troubleshooting Che
      • Viewing Che workspaces logs
      • Troubleshooting workspace start failures
      • Troubleshooting slow workspaces
      • Troubleshooting network problems
  • Installation Guide
    • Supported platforms
    • Configuring the Che installation
      • Using the OpenShift web console to configure the CheCluster Custom Resource during installation
      • Using the OpenShift web console to configure the CheCluster Custom Resource
      • Using chectl to configure the CheCluster Custom Resource during installation
      • Using the CLI to configure the CheCluster Custom Resource
    • Installing Che
      • Installing Che in cloud
        • Installing Che on OpenShift 4 using OperatorHub
        • Installing Che on OpenShift 4 using CLI
        • Installing Che on OpenShift 3
        • Installing Che on Kubespray
        • Installing Che on AWS
        • Installing Che on Google Cloud
        • Installing Che on Microsoft Azure
      • Installing Che locally
        • Installing Che on CodeReady Containers
        • Installing Che on Docker Desktop
        • Installing Che on Minikube
        • Installing Che on Minishift
        • Installing Che on Kind
      • Using the chectl management tool
      • Installing Che in restricted environment
    • Advanced configuration
      • Advanced configuration options for Che server
      • Configuring workspace target namespace
      • Configuring storage strategies
      • Configuring storage types
      • Configuring the number of workspaces that a user can run
      • Configuring the number of workspaces that a user can create
      • Configuring workspace exposure strategies
      • Configuring workspaces nodeSelector
      • Configuring Che hostname
      • Configuring Kubernetes Ingress
      • Configuring OpenShift Route
      • Deploying Che with support for Git repositories with self-signed certificates
      • Installing Che using storage classes
      • Importing untrusted TLS certificates to Che
      • Configuring communication between Che components
      • Setting up the Keycloak che-username-readonly theme for the Eclipse Che login page
      • Mounting a Secret or a ConfigMap as a file or an environment variable into a Eclipse Che container
      • Enabling DevWorkspace operator
    • Upgrading Che
      • Upgrading Che using OperatorHub
      • Upgrading Che using the CLI management tool
      • Upgrading Che in restricted environment
      • Updating Che namespace strategies other than 'per user'
    • Uninstalling Che
      • Using the OpenShift web console
      • Using OpenShift CLI
      • Using chectl
  • Administration Guide
    • Architecture overview
      • Che server based
        • Server side components
        • Workspace side components
      • DevWorkspace based
        • Server components
          • Che operator
          • DevWorkspace operator
          • Gateway
          • User dashboard
          • Devfile registries
          • Che server
          • PostgreSQL
          • Plug-in registry
        • User workspaces
    • Calculating Che resource requirements
    • Customizing the registries
      • Building custom registry images
      • Running custom registries
    • Retrieving Che logs
      • Configuring server logging
      • Accessing Kubernetes events on OpenShift
      • Viewing the Operator events on OpenShift
      • Viewing Che server logs
      • Viewing external service logs
      • Viewing Plug-in broker logs
      • Collecting logs using chectl
    • Monitoring Che
    • Monitoring the DevWorkspace operator
    • Tracing Che
    • Backup and disaster recovery
      • Setting up a backup server
      • Managing backups using CLI
        • Configuring CLI to use a backup server
      • Managing backups through custom resources
        • Configuring Che Operator to use a backup server
      • Persistent Volumes backups
      • External database setup
    • Migration from PostgreSQL 9 to PostgreSQL 13
    • Readiness init containers
      • Enabling and disabling the readiness init containers for the Operator installer
        • Enabling the readiness init containers for the Operator installer
        • Disabling the readiness init containers for the Operator installer
      • Enabling and disabling the readiness init containers for the OLM installer
        • Enabling the readiness init containers for the OLM installer
        • Disabling the readiness init containers for the OLM installer
    • Caching images for faster workspace start
      • Defining the list of images
      • Defining the memory settings
      • Installing using the Che Operator
      • Installing using the Kubernetes Image Puller Operator
      • Installing on OpenShift 4
      • Installing on OpenShift 3
    • Managing identities and authorizations
      • Authenticating users
      • Authorizing users
      • Configuring authorization
        • Configuring OpenShift OAuth
        • Configuring Minikube GitHub Authentication
      • Removing user data
  • Contributor Guide
    • Branding Che-Theia
    • Developing Che-Theia plug-ins
    • Testing Che-Theia plug-ins
    • Publishing Che-Theia plug-ins
    • Adding support for a new language
    • Adding support for a new debugger
    • Che extensibility reference
      • Che extension points
      • Che-Theia plug-in API
      • Debug Adapter Protocol
      • Language Server Protocol
  • Extensions
    • Eclipse Che4z
    • 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
    • Telemetry
      • Creating A Telemetry Plugin
      • The Woopra Telemetry Plugin
    • Java Lombok
    • Che glossary
Documentation 7.42.x
  • Documentation
    • next
    • 7.42.x
  • Documentation
  • End-user Guide
  • Authoring devfiles
next 7.42.x
Edit this Page

Authoring devfiles

  • Authoring devfiles version 1

  • Authoring a devfile 2

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