The following pages and posts are tagged with

TitleExcerpt
Commands and IDE Macros Commands are script-like instructions that are injected into the workspace machine for execution. Commands are saved in the configuration storage of your workspace and are part of any workspace export. Command Overview A command is defined by: A set of instructions to be injected into the workspace machine...
Workspace Management Creating Workspaces The easiest way to create a workspace is to use ready to go stacks in User Dashboard. Images and configuration in these stacks is certified both for Docker and OpenShift, and these are the stacks that are used in daily functional testing. There are multiple options...
Debug Che currently supports debuggers for: Java C/C++ (via GDB) PHP (via Zend debugger, zDebug and Z-Ray) Node.js (via GDB) Java Java debugger is deployed with the workspace agent, i.e. runs in the workspace. It can connect to local processes (those running in a...
Dependency Management Maven Currently Eclipse Che provides Maven plugin that is deployed with a workspace agent and started in a separate JVM. The plugin watches for changes in pom.xml, downloads dependencies that updates project’s classpath. You can forcefully update dependencies for a Maven project by calling context menu > Maven >...
Editor and Code Assistance Orion Editor Eclipse Che wraps Orion editor to integrate it with language servers, Git, debugger and other servvices that run on server and client side. Use of custom (user provided editors is possible). See: [Editor][editor]. Syntax Highlighting Syntax highlighting is provided by Orion editor out of the box....
Environment variables Environment variables are defined per machine. Depending on the infrastructure, they are added either to container or Kubernetes pod definition. You can add, edit and remove environment variables either in User Dashboard or directly in workspace machine configuration: "env": { <span...
Workspace Environments
Projects and Project Import Default Location of Projects When a workspace machine with a workspace agent starts, the IDE makes calls to Project API to get workspace projects. By default, they are located in projects in a machine container/pod. This location isn’t configurable as many other IDE components depend on it. Projects...
Installers What Are Installers? Installers are scripts that are injected into machines in a runtime and get executed there to: Prepare environment and download dependencies for particular software or tool Install chosen software and dependencies Launch software and tools in a certain way (arguments, mode etc) that provide extra...
Projects Projects in Workspaces Projects are always associated with a workspace and saved in a workspace configuration: "projects": [ { "description": "A basic example using Spring servlets. The app returns values entered into a submit...
Recipes Supported Recipe Formats Depending on the infrastructure, Che supports the following recipes out of the box (default Che build): Infrastructure Docker Image Dockerfile Composefile Kubernetes yaml Docker Supported Supported Supported Not supported OpenShift Supported Not supported Not supported Supported ...
Servers What Are Servers A server defines protocol and port of a process that runs in a machine. It also has a name and optional attributes, if this is a special purpose server, for example a [Language Server][TODO: language-servers]. In simple words, if you need to access a process...
Stacks What Are Stacks A stack is a template of workspace configuration and some meta-information like scope, tags, components, description, name and ID. Stacks are used by User Dashboard to make it easy to create workspaces and well as filter sample projects compatible with a chosen stack. Stacks are...
Volumes Default Volumes By default workspace containers/pods start with one default volume/PVC that persists /projects where workspace projects are physically located. When a workspace is stopped its machines are destroyed, however, volumes stay there. User-Provided Volumes Your workspace may need additional volumes though, say, to persist a local...
What Is a Che Workspace? Workspace Eclipse Che reinvents the definition of a workspace which is usually termed as a local directory with projects and some meta-information that IDE uses to properly configure them. In Eclipse Che, a workspace is the developer environment itself represented by Docker containers, k8s pods or something else (for...
Workspace Data Model environments: Map<String, getEnvironments> // Workspace envs. A workspace can have multiple envs defaultEnv: STRING // A workspace should have a default environment projects: [] // Projects associated with a workspace commands: [] // Commands associated with a workspace name: STRING // Workspace name that has to be...
Workspace REST API
Troubleshooting Workspace Start Failures {% include links.html %} Failures to start a workspace may be caused by different factors: 1. Environment recipe 2. Network conditions ## Bad Recipes When a workspace is being started, environment [recipe][recipes] is sent to Docker or OpenShift API. Che server then listens to events provided by a particular infrastructure....