Configuring a Che 7.42 workspace

Changing the configuration of an existing workspace

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

Prerequisites

  • A running instance of Che. See Installing Che.

  • An existing workspace defined on this instance of Che.

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.

    • Review namespace.

  5. From the Devfile tab, edit YAML configuration of the workspace. See Authoring a devfile 2.

Adding projects to your workspace

Prerequisites

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

  • An existing workspace defined on this instance of Che.

Procedure

To add a project to your workspace:

  1. Navigate to the Workspaces page and click the workspace, which is about to be updated.

  2. Open the Devfile tab.

  3. In the Devfile editor, add a projects section with desired project.

    Edit Devfile Content

  4. Once the project is added, click the Save button to save this workspace configuration.

    For demonstration example, see below:

    Example - Adding a .git project into a workspace using a devfile

    In the following instance, the project che acts as the example of a user’s project. A user specifies this project using the name attribute of a devfile. The location attribute defines the source repository represented by an URL to a Git repository or zip archive.

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

    projects:
  - name: <che>
    source:
      type: git
      location: 'https://github.com/<github-organization>/<che>.git'

    For additional information, see the Devfile reference section.

Configuring the workspace tools

Adding plug-ins

Prerequisites

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

  • An existing workspace defined on this instance of Che.

Procedure

To add plug-ins to your workspace:

  1. Click the Devfile tab.

  2. Add the desired chePlugin component and click the Save button.

    To see a list of available plugins, activate the completion feature by pressing Ctrl+Space.
    workspace add plugin

Defining the workspace editor

Prerequisites

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

  • An existing workspace defined on this instance of Che.

Procedure

To define the editor to use with the workspace:

  1. Click the Devfile tab.

  2. Add the desired cheEditor component and click the Save button.

    To see a list of available plugins, activate the completion feature by pressing Ctrl+Space. The recommended editor for Che 7.42 is Che-Theia.
    workspace add editor
Additional resources