Creating a workspace from code sample

Every stack includes a sample codebase, which is defined by the devfile of the stack. This section explains how to create a workspace from this code sample in a sequence of three procedures.

  1. Creating a workspace from the user dashboard:

    1. Using the Get Started view.

    2. Using the Custom Workspace view.

  2. Changing the configuration of the workspace to add code sample.

  3. Running an existing workspace from the user dashboard.

For more information about devfiles, see Configuring a workspace using a devfile.

Creating a workspace from Get Started view of User Dashboard

This section describes how to create a workspace from the User Dashboard.

Prerequisites
  • A running instance of Eclipse Che. To install an instance of Eclipse Che, see Installing Che.

Procedure
  1. Navigate to the Che Dashboard. See Navigating Che using the Dashboard.

  2. In the left navigation panel, go to Get Started.

  3. Click the Get Started tab.

  4. In the gallery, there is list of samples that may be used to build and run projects.

    Select a stack from the gallery
    Changing resource limits

    Changing the memory requirements is only possible from the devfile. See Changing the configuration of an existing workspace.

  5. Start the workspace: click the chosen stack card.

    Create and Open
New workspace name

Workspace name can be auto-generated based on the underlying devfile of the stack. Generated names always consist of the devfile metadata.generateName property as the prefix and four random characters.

Creating a workspace from Custom Workspace view of User Dashboard

This section describes how to create a workspace from the User Dashboard.

Prerequisites
  • A running instance of Eclipse Che. To install an instance of Eclipse Che, see Installing Che.

Procedure
  1. Navigate to the Che Dashboard. See Navigating Che using the Dashboard.

  2. In the left navigation panel, go to Get Started.

  3. Click the Custom Workspace tab.

  4. Define a Name for the workspace.

    New workspace name

    Workspace name can be auto-generated based on the underlying devfile of the stack. Generated names always consist of the devfile metadata.generateName property as the prefix and four random characters.

  5. In the Devfile section, select the devfile template that will be used to build and run projects.

    Select a devfile from the list
    Changing resource limits

    Changing the memory requirements is only possible from the devfile. See Changing the configuration of an existing workspace.

  6. Start the workspace: click the Create & Open button at the bottom of the form:

    Create and Open

Changing the configuration of an existing workspace

This section describes how to change the configuration of an existing workspace from the User Dashboard.

Prerequisites
Procedure
  1. Navigate to the Che Dashboard. See Navigating Che using the Dashboard.

  2. In the left navigation panel, go to Workspaces.

  3. Click the name of a workspace to navigate to the configuration overview page.

  4. Click the Overview tab and execute following actions:

    • Change the Workspace name.

    • Select Storage Type.

    • Export the workspace configuration to a file or private cloud.

    • Delete the workspace.

      Workspace configuration overview
  5. In the Projects section, choose the projects to integrate in the workspace.

    1. Click the Add Project button and do one of the following:

      1. Enter the project Git repository URL to integrate in the workspace:

        Add project by URL to workspace
      2. Connect your GitHub account and select projects to integrate:

        Add project from GitHub to workspace
    2. Click the Add button.

  6. In the Plugins section, choose the plug-ins to integrate in the workspace.

    Example

    Start with a generic Java-based stack, then add support for Node.js or Python.

  7. In the Editors section, choose the editors to integrate in the workspace. The Che 7.18 editor is based on Che-Theia.

  8. From the Devfile tab, edit YAML configuration of the workspace. See Making a workspace portable using a devfile.

    Example: add commands
    YAML configuration
    Example: add a project

    To add a project into the workspace, add or edit the following section:

    projects:
      - name: che
        source:
          type: git
          location: 'https://github.com/eclipse/che.git'

Running an existing workspace from the User Dashboard

This section describes how to run an existing workspace from the User Dashboard.

Running an existing workspace from the User Dashboard with the Run button

This section describes how to run an existing workspace from the User Dashboard using the Run button.

Prerequisites
Procedure
  1. Navigate to the Che Dashboard. See Navigating Che using the Dashboard.

  2. In the left navigation panel, navigate to Workspaces.

  3. Click on the name of a non-running workspace to navigate to the overview page.

  4. Click on the Run button in the top right corner of the page.

  5. The workspace is started.

  6. The browser does not navigates to the workspace.

Running an existing workspace from the User Dashboard using the Open button

This section describes how to run an existing workspace from the User Dashboard using the Open button.

Prerequisites
Procedure
  1. Navigate to the Che Dashboard. See Navigating Che using the Dashboard.

  2. In the left navigation panel, navigate to Workspaces.

  3. Click on the name of a non-running workspace to navigate to the overview page.

  4. Click on the Open button in the top right corner of the page.

  5. The workspace is started.

  6. The browser navigates to the workspace.

Running an existing workspace from the User Dashboard using the Recent Workspaces

This section describes how to run an existing workspace from the User Dashboard using the Recent Workspaces.

Prerequisites
Procedure
  1. Navigate to the Che Dashboard. See Navigating Che using the Dashboard.

  2. In the left navigation panel, in the Recent Workspaces section, right-click the name of a non-running workspace and click Run in the contextual menu to start it.

    Run from Recent Workspaces