Skip to content

Commit

Permalink
Merge pull request #768 from MichalMaler/i1144-Running_Che_remotely
Browse files Browse the repository at this point in the history
Running Che remotely
  • Loading branch information
Robert Krátký authored Jul 31, 2019
2 parents 5da487f + 0ffda7b commit 1062a83
Show file tree
Hide file tree
Showing 57 changed files with 1,001 additions and 36 deletions.
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.
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.
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.
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.
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.
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.
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.
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/installation/dns-nameservers.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.
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.
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.
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.
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/installation/tls-mode-true.png
15 changes: 4 additions & 11 deletions src/main/pages/che-7/overview/assembly_che-quick-starts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,26 +20,19 @@ This section contains instructions for gettiong quickly started with Eclipse Che

* xref:running-che-locally_che-quick-starts[Start Che on your local workstation] using Minikube, Minishift, or Docker Desktop

//* Use the *Dashboard* to navigate the application and select predefined stacks
//* Start using the integrated development environment (IDE) provided by Che

// [id='prerequisites-{context}']
// == Prerequisites
//
// * 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.
include::proc_running-che-locally.adoc[leveloffset=+1]

include::assembly_deploying-che-on-kubernetes-on-aws.adoc[leveloffset=+1]

include::assembly_installing-che-on-openshift-3-using-the-operator.adoc[leveloffset=+1]

include::proc_running-che-locally.adoc[leveloffset=+1]
include::assembly_installing-che-on-openshift-4-from-operatorhub.adoc[leveloffset=+1]

//include::proc_navigating-che-using-the-dashboard.adoc[leveloffset=+1]

//include::proc_using-the-ide.adoc[leveloffset=+1]



// [id='related-information-{context}']
// == Related information
//
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// che-quick-starts

:parent-context-of-deploying-che-on-kubernetes-on-aws: {context}

[id='deploying-che-on-kubernetes-on-aws_{context}']
= Deploying Che on Kubernetes on AWS

:context: deploying-che-on-kubernetes-on-aws

include::proc_preparing-the-aws-system-for-installing-che.adoc[leveloffset=+1]

include::proc_installing-che-on-kubernetes-using-the-chectl-command.adoc[leveloffset=+1]

////
[id='related-information-{context}']
== Related information
* 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].
////

:context: {parent-context-of-deploying-che-on-kubernetes-on-aws}
3 changes: 1 addition & 2 deletions src/main/pages/che-7/overview/assembly_hosted-che.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,7 @@ include::proc_contributing-to-github-projects-in-hosted-che.adoc[leveloffset=+1]

include::proc_finding-the-cluster-where-the-hosted-che-workspace-is-running.adoc[leveloffset=+1]

[discrete]
== Additional resources
.Additional resources

* 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].

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// che-quick-starts

:parent-context-of-installing-che-on-openshift-3-using-the-operator: {context}

[id='installing-che-on-openshift-3-using-the-operator_{context}']
= Installing Che on OpenShift 3 using the operator

:context: installing-che-on-openshift-3-using-the-operator

.Prerequisites

* A running instance of OpenShift 3.11
* The `oc` tool installed
* The `chectl` tool installed
* Administrator rights to the OpenShift installation (needed by `che-role`)

include::proc_preparing-openshift-for-installing-che.adoc[leveloffset=+1]

include::proc_installing-che-on-openshift-using-the-operator.adoc[leveloffset=+1]

include::proc_installing-che-on-openshift-using-the-operator-and-ssl.adoc[leveloffset=+1]

////
[id='related-information-{context}']
== Related information
* 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].
////

:context: {parent-context-of-installing-che-on-openshift-3-using-the-operator}
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
// che-quick-starts

:parent-context-of-installing-che-on-openshift-4-from-operatorhub: {context}

[id='installing-che-on-openshift-4-from-operatorhub_{context}']
= Installing Che on OpenShift 4 from OperatorHub

:context: installing-che-on-openshift-4-from-operatorhub

Eclipse Che can be installed from OpenShift OperatorHub.

include::proc_installing-che-on-openshift-4.adoc[leveloffset=+1]

include::proc_enabling-ssl-on-openshift-4.adoc[leveloffset=+1]

////
[id='related-information-{context}']
== Related information
* 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].
////
:context: {parent-context-of-installing-che-on-openshift-4-from-operatorhub}
3 changes: 1 addition & 2 deletions src/main/pages/che-7/overview/con_features-and-benefits.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ The contents of a concept module give the user descriptions and explanations nee
* Explain only things that are visible to users. Even if a concept is interesting, it probably does not require explanation if it is not visible to users.
* Do not include any instructions to perform an action, such as executing a command. Action items belong in procedure modules.

[discrete]
== Additional resources
.Additional resources

* A bulleted list of links to other material closely related to the contents of the concept module.
* For more details on writing concept modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
Expand Down
3 changes: 1 addition & 2 deletions src/main/pages/che-7/overview/con_introductory-videos.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ The contents of a concept module give the user descriptions and explanations nee
* Explain only things that are visible to users. Even if a concept is interesting, it probably does not require explanation if it is not visible to users.
* Do not include any instructions to perform an action, such as executing a command. Action items belong in procedure modules.

[discrete]
== Additional resources
.Additional resources

* A bulleted list of links to other material closely related to the contents of the concept module.
* For more details on writing concept modules, see the link:https://github.com/redhat-documentation/modular-docs#modular-documentation-reference-guide[Modular Documentation Reference Guide].
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// installing-che-on-openshift-4-from-operatorhub

[id="enabling-ssl-on-openshift-4_{context}"]
= Enabling SSL on OpenShift 4

.Procedure

To enable SSL on Openshift 4:

. Toggle the *TLS MODE* switch to *True*.
+
image::installation/set-that-value-to-true-enabeling-tls-mode.png[link="{imagesdir}/installation/set-that-value-to-true-enabeling-tls-mode.png"]
+
image::installation/tls-mode-true.png[link="{imagesdir}/installation/tls-mode-true.png"]

. Click *Confirm change*.
. In the *Resources* section, the pods are restarted.
+
image::installation/resource-section-pods-are-restarted.png[link="{imagesdir}/installation/resource-section-pods-are-restarted.png"]

. Click the *ECLIPSE CHE URL* link.
+
image::installation/eclipse-che-url-link.png[link="{imagesdir}/installation/eclipse-che-url-link.png"]
+
Notice that the link is redirected to HTTPS.
+
image::installation/link-is-redirected-to-https.png[link="{imagesdir}/installation/link-is-redirected-to-https.png"]
+
A valid _Let’s Encrypt_ certificate is available, and Che is available on HTTPS.

.An example of Eclipse Che running on OpenShift v4.1 with SSL
image::installation/che-running-on-openshift-v4.png[link="{imagesdir}/installation/che-running-on-openshift-v4.png"]
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
// deploying-che-on-kubernetes-on-aws

[id="installing-che-on-kubernetes-using-the-chectl-command_{context}"]
= Installing Che on Kubernetes using the chectl command

.Procedure

To install Che:

. Run the following command:
+
[subs="+quotes",options="nowrap"]
----
$ chectl server:start --platform=k8s --installer=helm --domain=aws.my-ide.cloud --multiuser --tls
✔ ✈️ Kubernetes preflight checklist
✔ Verify if kubectl is installed
✔ Verify remote kubernetes status...done.
✔ Verify domain is set...set to aws.my-ide.cloud.
✔ 🏃‍ Running Helm to install Che
✔ Verify if helm is installed
✔ Check for TLS secret prerequisites...che-tls secret found.
✔ Create Tiller Role Binding...it already exist.
✔ Create Tiller Service Account...it already exist.
✔ Create Tiller RBAC
✔ Create Tiller Service...it already exist.
✔ Preparing Che Helm Chart...done.
✔ Updating Helm Chart dependencies...done.
✔ Deploying Che Helm Chart...done.
✔ ✅ Post installation checklist
✔ PostgreSQL pod bootstrap
✔ scheduling...done.
✔ downloading images...done.
✔ starting...done.
✔ Keycloak pod bootstrap
✔ scheduling...done.
✔ downloading images...done.
✔ starting...done.
✔ Che pod bootstrap
✔ scheduling...done.
✔ downloading images...done.
✔ starting...done.
✔ Retrieving Che Server URL...https://che-che.aws.my-ide.cloud
✔ Che status check
Command server:start has completed successfully.
----

. The certificate generated by Let’s Encrypt is a valid certificate.
+
image::installation/certificate-generate-lets-encrypt.png[link="{imagesdir}/installation/certificate-generate-lets-encrypt.png"]
+
image::installation/eclipse-che-welcome-to-your-workspace.png[link="{imagesdir}/installation/eclipse-che-welcome-to-your-workspace.png"]

// .Additional Resources
//
// TODO: * For installation of Che on the Google Cloud platform, see link:https://docs.google.com/document/d/1T5N7oB3XDgABAA9mebJWeTeDflKxq5NXDM1QI9mmQfE/edit#[Installing multi-user Che with TLS on Google Cloud Platform] guide.
//
// TODO: * For installation of Che on Azure, see
// link:https://docs.google.com/document/d/1WSB5VTS0sBask5lE0pyhH5Gp-8qC4xXr8NgckF0b0Z8/edit[Running Eclipse Che on
// Microsoft Azure].
143 changes: 143 additions & 0 deletions src/main/pages/che-7/overview/proc_installing-che-on-openshift-4.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
// installing-che-on-openshift-4-from-operatorhub

[id="installing-che-on-openshift-4_{context}"]
= Installing Che on OpenShift 4


.Procedure

To install Che on OpenShift 4:

== Creating the che project

. Create a project named *che* using the *Projects tab*.
. Click the *Create Project* button.
+
image::installation/open-shift-create-project.png[link="{imagesdir}/installation/open-shift-create-project.png"]

. In the *Name* field, type `che` and click the btn:[Create] button.
+
image::installation/create-project-button.png[link="{imagesdir}/installation/create-project-button.png"]

== Installing the operator

. After the Che project is created, install the operator. In the left panel, expand *Catalog* and click *OperatorHub*.
+
image::installation/catalog-operatorhub.png[link="{imagesdir}/installation/catalog-operatorhub.png"]

. In the *Search by keyword* field, type `eclipse che`.
+
image::installation/eclipse-che-in-openshift-creation.png[link="{imagesdir}/installation/eclipse-che-in-openshift-creation.png"]

. Click *Eclipse Che*.
+
image::installation/select-eclipse-che-in-openshift.png[link="{imagesdir}/installation/select-eclipse-che-in-openshift.png"]

. Click the btn:[Install] button in the *Eclipse Che* pop-up window.
+
image::installation/install-eclipse-che-in-openshift.png[link="{imagesdir}/installation/install-eclipse-che-in-openshift.png"]

. In the *A specific namespace* field in the cluster drop-down list, select *che*. Click the btn:[Subscribe] button.
+
image::installation/eclipse-che-create-operator-subscription.png[link="{imagesdir}/installation/eclipse-che-create-operator-subscription.png"]
+
The operator is successfully installed and is available in the *Installed Operators* section.
+
image::installation/eclipse-che-overview.png[link="{imagesdir}/installation/eclipse-che-overview.png"]

== Deploying Che

. Navigate to the *Catalog -> Installed Operators* section.
+
image::installation/eclipse-che-installed-operators.png[link="{imagesdir}/installation/eclipse-che-installed-operators.png"]
+
Eclipse Che is displayed as an installed operator having the *InstallSucceeded* status.

. To deploy Che, click *Eclipse Che* in the list of installed operators.
+
image::installation/eclipse-che-overview-provided-apis.png[link="{imagesdir}/installation/eclipse-che-overview-provided-apis.png"]

. Click the *Create New* link in *Provided APIs* section.
+
image::installation/cc-eclipse-che-cluster.png[link="{imagesdir}/installation/cc-eclipse-che-cluster.png"]

. Leave the default values as they are and click the btn:[Create] button in the bottom-left corner of the window.
+
image::installation/create-che-cluster-intalled-operators.png[link="{imagesdir}/installation/create-che-cluster-intalled-operators.png"]
+
As a result, the Eclipse Che cluster is created.
+
image::installation/eclipse-che-cluster-create-che-cluster.png[link="{imagesdir}/installation/eclipse-che-cluster-create-che-cluster.png"]

== Tracking the Che deployment

. To track the deployment, click the *eclipse-che* cluster.
+
image::installation/eclipse-che-cluster-overview.png[link="{imagesdir}/installation/eclipse-che-cluster-overview.png"]

. Click the *Resources* tab.
+
image::installation/eclipse-che-resources-tab.png[link="{imagesdir}/installation/eclipse-che-resources-tab.png"]
+
It is also possible to track the deployment using the command line and the following two commands:
+
[subs="+quotes",options="nowrap"]
----
$ oc project che
$ oc get pods
NAME READY STATUS RESTARTS AGE
che-8495f4946b-jrzdc 0/1 Running 0 86s
che-operator-578765d954-99szg 1/1 Running 0 42m
keycloak-74fbfb9654-g9vp5 1/1 Running 0 4m32s
postgres-5d579c6847-w6wx5 1/1 Running 0 5m14s
----

== Viewing che-operator logs

. To view the che-operator logs, run the following command:
+
[subs="+quotes",options="nowrap"]
----
$ oc logs --tail=10 -f che-operator-578765d954-99szg
time="2019-07-12T09:48:29Z" level=info msg="Exec successfully completed"
time="2019-07-12T09:48:29Z" level=info msg="Updating eclipse-che CR with status: provisioned with OpenShift identity provider: true"
time="2019-07-12T09:48:29Z" level=info msg="Custom resource eclipse-che updated"
time="2019-07-12T09:48:29Z" level=info msg="Creating a new object: ConfigMap, name: che"
time="2019-07-12T09:48:29Z" level=info msg="Creating a new object: ConfigMap, name: custom"
time="2019-07-12T09:48:29Z" level=info msg="Creating a new object: Deployment, name: che"
time="2019-07-12T09:48:30Z" level=info msg="Updating eclipse-che CR with status: Che API: Unavailable"
time="2019-07-12T09:48:30Z" level=info msg="Custom resource eclipse-che updated"
time="2019-07-12T09:48:30Z" level=info msg="Waiting for deployment che. Default timeout: 420 seconds"
----

. To obtain the Eclipse Che URL, wait for the logs to show the following information:
+
[subs="+quotes",options="nowrap"]
----
time="2019-07-12T09:50:13Z" level=info msg="Updating eclipse-che CR with Eclipse Che server URL: http://che-che.apps.cluster-fre-f0a2.fre-f0a2.openshiftworkshop.com"
time="2019-07-12T09:50:13Z" level=info msg="Custom resource eclipse-che updated"
time="2019-07-12T09:50:13Z" level=info msg="Eclipse Che is now available at: http://che-che.apps.cluster-fre-f0a2.fre-f0a2.openshiftworkshop.com"
time="2019-07-12T09:50:13Z" level=info msg="Updating eclipse-che CR with version: 7.0.0-RC-2.0"
----
+
The URL is also displayed in the Eclipse Che cluster on the *Installed Operators* window in the *ECLIPSE CHE URL* field.
+
image::installation/eclipse-che-url-filef-overview.png[link="{imagesdir}/installation/eclipse-che-url-filef-overview.png"]

. Click on the *Eclipse Che URL* link to display the Eclipse Che login page.
+
image::installation/eclipse-che-login-page.png[link="{imagesdir}/installation/eclipse-che-login-page.png"]

. To log in, use OpenShift OAuth or register as a new user. To use OAuth, the user must grant permissions to log in to Eclipse Che.
+
image::installation/authorize-access-for-eclipse-che-openshift.png[link="{imagesdir}/installation/authorize-access-for-eclipse-che-openshift.png"]

. Update account information.
+
image::installation/update-account-information-eclipse-che.png[link="{imagesdir}/installation/update-account-information-eclipse-che.png"]
+
When the user is logged in, the Eclipse Che *Dashboard* displays where the user can create a workspace.
+
image::installation/eclipse-che-loading.png[link="{imagesdir}/installation/eclipse-che-loading.png"]
+
image::installation/eclipse-che-loading.png[link="{imagesdir}/installation/eclipse-che-loading.png"]
Loading

0 comments on commit 1062a83

Please sign in to comment.