This section describes procedures to get started with Hosted Che that are not covered by Using developer environments - workspaces.

About Hosted Che

Hosted Che is Eclipse Che hosted by Red Hat. A Che server is running on OpenShift Dedicated, and the user base is spread across multiple OpenShift Online clusters where workspaces are created.

Terms of service

Hosted Che has the following usage limits and terms of service:

  • Storage: 1 GB

  • RAM: 3 GB

  • CPU: 6 Cores

  • Concurrent workspaces: 1

  • Number of workspaces: Unlimited

  • Number of projects per workspace: Unlimited

  • Usage time limit: None

  • Maximum account inactivity period: 30 days

    Hosted Che automatically deprovisions accounts that have been inactive for more than 30 days. All existing workspaces in a deprovisioned account are lost. To start using Hosted Che again, a user must re-register.

  • Workspace idling time: 15 minutes

    A started workspace can be used for an unlimited period of time. When there are no interactions with the IDE, the workspace is stopped after 15 minutes.

  • Ephemeral mode: Defaults to Active

    In ephemeral mode, workspaces have no persistent storage attached. All content changes are lost when the workspace is stopped unless they are pushed to a source-code repository first. This is done to improve the performance of workspace starts and file-system operations in the IDE.

It is possible to disable ephemeral mode while creating a workspace from the user dashboard. For more information about ephemeral mode, including how to disable it after workspace creation, see Using developer environments - workspaces.

Registering to Hosted Che

This section describes how to register to Hosted Che.

Procedure

  1. Navigate to Hosted Che.

  2. Log in with an existing OpenShift Online, Red Hat Developer Program, or Red Hat Customer Portal account, or register for a new Red Hat account.

  3. Click the Activate account button.

  4. Wait for an email with a link to connect to the Eclipse Che instance. It is sent after the environment is ready for use.

  5. Follow the Get Started link in the email.

The Hosted Che user dashboard is displayed.

Creating a worskpace from the user dashboard

This section describes how to create a workspace from the user dashboard in Hosted Che.

Prerequisites
Procedure

  1. Navigate to the Hosted Che user dashboard.

  2. Click the Create Workspace button.

  3. Define a Name for the workspace. A generated name is proposed. It can be modified.

  4. In the Stack section, select the workspace runtime environment that will be used to build and run projects from the list.

  5. In the RAM section, adapt the memory available for the workspace runtime environment within the limits defined in the terms of service.

  6. In the Ephemeral mode section, choose to have persistent storage attached or not.

  7. In the Projects section, choose the projects to integrate in the workspace. For the specific GitHub case, see Importing projects from GitHub in Hosted Che.

Additional resources

Creating a workspace from a template in Hosted Che

This section describes how to create a workspace from a predefined template.

Various programming languages and frameworks are supported.

Prerequisites
Procedure

  1. Navigate to the templates registry.

  2. Choose the required flavor.

  3. Click the Launch Workspace button.

The workspace is created and displayed in Hosted Che.

getting started devfile

Importing projects from GitHub in Hosted Che

This section describes how to import a GitHub project in Hosted Che.

The user can import a GitHub project during the creation of a new workspace, or later, in an existing workspace.

Prerequisites
Procedure

  1. Navigate to the Projects section of the New Workspace creation window.

    Alternatively if the workspace is already existing, navigate to the Projects section of the Configure Workspace window.

  2. Click the Add Project button.

  3. Navigate to the GitHub tab.

  4. Click the Connect your GitHub account button.

  5. In the pop-up window, review the settings and click the Authorize openshiftio button.

  6. Type the password as requested and click the Confirm password button.

  7. Select the required repositories and click the Add button.

Contributing to GitHub projects in Hosted Che

This section describes how to contribute to GitHub projects in Hosted Che.

Prerequisites
Procedure

  1. Generate an SSH key pair with the SSH Plug-in.

  2. Upload the public key to the GitHub account. For details, see the Adding a new SSH key to your GitHub account procedure.

Finding the cluster where the Hosted Che workspace is running

This section describes how to find the cluster where the Hosted Che workspace is running with a query to the OpenShift API on Hosted Che.

Prerequisites

  • The curl and jq packages are installed

  • Make a note of the username or email credential that the user used to log into Hosted Che

Procedure

  1. Find the cluster name using the username.

    $ curl -sgSL "https://api.openshift.io/api/users?filter[username]=<username>" | jq -r ".data[0].attributes.cluster"

  2. Find the cluster name using the email.

    $ curl -sgSL "https://api.openshift.io/api/users?filter[email]=<email>" | jq -r ".data[0].attributes.cluster"

The output of the query is the OpenShift Online cluster URL

+ .Example

https://api.starter-us-east-2.openshift.com/

  1. Browse to the previously retrieved URL.

  2. Log in using the OpenShift Online credentials.

The Openshift Console is displayed.

The <username>-che namespace where all the workspace related pods are created are accessible in read-only mode.

+ image::/che/docs/images/hosted-che/finding-the-cluster-where-the-hosted-che-workspace-is-running.png[]

Additional resources
Tags: