Skip to content

Commit

Permalink
che-docs #715 Adding documentation for Hosted Che
Browse files Browse the repository at this point in the history
Signed-off-by: Ilya Buziuk <ibuziuk@redhat.com>
  • Loading branch information
ibuziuk committed Jul 5, 2019
1 parent 322afc9 commit d53dfc7
Show file tree
Hide file tree
Showing 9 changed files with 66 additions and 18 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ pkg/
test/
.jekyll-metadata
.sass-cache/
.classpath
.project
.settings/

# Idea #
##################
Expand Down
Binary file added src/main/images/hosted-che/ephemeral-toggle.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/images/hosted-che/getting-started-ud.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/images/hosted-che/gh-account-linking.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/images/hosted-che/registration-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/images/hosted-che/registration-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/main/images/hosted-che/registration-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
81 changes: 63 additions & 18 deletions src/main/pages/che-7/overview/assembly_hosted-che.adoc
Original file line number Diff line number Diff line change
@@ -1,40 +1,85 @@
---
title: Hosted Che
keywords:
tags: []
tags: [Hosted Che]
sidebar: che_7_docs
permalink: che-7/hosted-che.html
folder: che-7/overview
summary:
---

:parent-context-of-hosted-che: {context}

[id='hosted-che_{context}']
[id="hosted-che"]
= Hosted Che

:context: hosted-che
"Hosted Che" is link:https://www.eclipse.org/che/[Eclipse Che] hosted by Red Hat. Che server is running on OpenShift Dedicated and user base is spread across multiple OpenShift Online clusters where workspaces are created.

[id="terms-of-service"]
== Terms of Service

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

- Storage: `1GB`
- RAM: `3GB`
- 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`

NOTE: If a user is not login to "Hosted Che" for more than 30 days the account will be automatically deprovisioned and all existing workspaces will be lost. In order to start using "Hosted Che" again a user will need to re-register again.

- Workspace Idling time: `15 minutes`

NOTE: Once started workspace can be used for unlimited period of time. However, if there are no interactions with IDE workspace will be gracefully stopped.

- Ephemeral by default

NOTE: In the ephemeral mode workspace has no PVC attached, which means that all changes to the source code will be lost when the workspace is stopped unless they are pushed to a source code repository. This is done in order to improve the performance of the file system operations. User can disable ephemeral mode using the dedicated toggle during the workspace creation process from the "User Dashboard"

image::hosted-che/ephemeral-toggle.png[]

[id="registration"]
== Register to Hosted Che

- Navigate to https://che.openshift.io/.
- Log in with your existing OpenShift Online, Red Hat Developer Program, or Red Hat Customer Portal account, or register for a Red Hat account if you don't have one already.

image::hosted-che/registration-1.png[]

- In the next screen, activate your account by clicking on the *Activate account* button.

image::hosted-che/registration-2.png[]

- Once your environment is being built and then complete, you will receive an email with a link to connect to your Eclipse Che instance.

- Follow the link and the email and start to use Hosted Che by clicking on the *Get Started* button which will redirect you to the User Dashboard.

image::hosted-che/registration-3.png[]

[id="getting-started"]
== Getting started
Follow the wizard to create a workspace from the "User Dashboard":

This paragraph is the assembly introduction. It explains what the user will accomplish by working through the modules in the assembly and sets the context for the user story the assembly is based on. Can include more than one paragraph. Consider using the information from the user story.
image::hosted-che/getting-started-ud.png[]

[id='prerequisites-{context}']
== Prerequisites
You can also create a workspace from a predifined link:https://www.eclipse.org/che/getting-started/cloud/[Getting started] devfiles which provides various set of the programming languages and frameworks:

* A bulleted list of conditions that must be satisfied before the user starts following this assembly.
* You can also link to other modules or assemblies the user must follow before starting this assembly.
* Delete the section title and bullets if the assembly has no prerequisites.
- Navigate to https://www.eclipse.org/che/getting-started/cloud/
- Choose the desired flavor and launch your new Workspace.

image::hosted-che/getting-started-devfile.png[]

Include modules here.
[id='github-account-linking']
== Link your GitHub Account

You can also link your account and import projects directly from GitHub during workspace creation from the "User Dashboard":

image::hosted-che/gh-account-linking.png[]

[id='related-information-{context}']
== Related information
NOTE: In order to use push the source code to GitHub from IDE you will need to generate SSH keys using the link:https://github.com/eclipse/che-theia/tree/master/plugins/ssh-plugin[SSH Plug-in] and upload the public key to your GitHub account (`Settings` -> `SSH and GPG keys` -> `New SSH key`)

* A bulleted list of links to other material closely related to the contents of the concept module.
* For more details on writing assemblies, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
* Use a consistent system for file names, IDs, and titles. For tips, see _Anchor Names and File Names_ in link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
[id='faq']
== Frequently Asked Questions (FAQs) and Troubleshooting

:context: {parent-context-of-hosted-che}
Frequently Asked Questions (FAQs) and Troubleshooting can be found on the following link:https://github.com/redhat-developer/rh-che/blob/master/FAQ.adoc[link].

0 comments on commit d53dfc7

Please sign in to comment.