Skip to content

Commit

Permalink
docs: Adding 'Integrating with Kubernetes' user guide (#2250)
Browse files Browse the repository at this point in the history
Signed-off-by: Ilya Buziuk <ibuziuk@redhat.com>
  • Loading branch information
ibuziuk authored Mar 31, 2022
1 parent 68f1597 commit 81118eb
Show file tree
Hide file tree
Showing 9 changed files with 51 additions and 3 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.
2 changes: 2 additions & 0 deletions modules/end-user-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
** xref:secret-as-a-variable.adoc[]
** xref:git-credential-store.adoc[]
* xref:integrating-with-kubernetes.adoc[]
** xref:automatic-token-injection.adoc[]
** xref:navigating-che-from-openshift-developer-perspective.adoc[]
** xref:navigating-openshift-web-console-from-che.adoc[]
* xref:troubleshooting-che.adoc[]
** xref:viewing-che-workspaces-logs.adoc[]
** xref:investigating-failures-at-a-workspace-start-using-the-verbose-mode.adoc[]
Expand Down
21 changes: 21 additions & 0 deletions modules/end-user-guide/pages/automatic-token-injection.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
:navtitle: Automatic {orch-name} token injection
:keywords: user-guide, token, injection
:page-aliases: .:automatic-token-injection, overview:automatic-token-injection

[id="automatic-token-injection_{context}"]
= Automatic {orch-name} token injection

This section describes how to use the {orch-name} user token that is automatically injected into workspace containers which allows running {prod-short} CLI commands against {orch-name} cluster.

.Procedure

. Open the {prod-short} dashboard and start a workspace.

. Once the workspace is started, open a terminal in the container that contains the {prod-short} CLI.

. Execute {prod-short} CLI commands which allow you to run commands against {orch-name} cluster. CLI can be used for deploying applications, inspecting and managing cluster resources, and viewing logs. {orch-name} user token will be used during the execution of the commands.

+
image::integration/token-injection.png[Token Injection in IDE,link="../_images/integration/token-injection.png"]

WARNING: The automatic token injection currently works only on the OpenShift infrastructure.
2 changes: 2 additions & 0 deletions modules/end-user-guide/pages/integrating-with-kubernetes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@
[id="integrating-with-kubernetes_{context}"]
= Integrating with {orch-name}

* xref:automatic-token-injection.adoc[]
* xref:navigating-che-from-openshift-developer-perspective.adoc[]
* xref:navigating-openshift-web-console-from-che.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,11 @@

:context: accessing-{prod-id-short}-from-openshift-developer-perspective


The OpenShift Container Platform web console provides two perspectives; the *Administrator* perspective and the *Developer* perspective.

The Developer perspective provides workflows specific to developer use cases, such as the ability to:

* Create and deploy applications on OpenShift Container Platform by importing existing codebases, images, and Dockerfiles.
* Create and deploy applications on the OpenShift Container Platform by importing existing codebases, images, and Dockerfiles.

* Visually interact with applications, components, and services associated with them within a project and monitor their deployment and build status.

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
:navtitle: Navigating OpenShift web console from {prod-short}
:keywords: overview, OpenShift, web console
:page-aliases: .:accessing-openshift-web-console-from-che, overview:accessing-openshift-web-console-from-che, accessing-openshift-web-console-from-che

:parent-context-of-accessing-che-from-openshift-developer-perspective: {context}

[id="navigating-openshift-web-console-from-{prod-id-short_{context}"]
= Navigating OpenShift web console from {prod-short}

This section describes how to access OpenShift web console from {prod-short}.

.Prerequisites

* The {prod-short} Operator is available in OpenShift 4.

.Procedure

. Open the {prod-short} dashboard and click the three-by-three matrix icon in the upper right corner of the main screen.
+
The drop-down menu displays the available applications.
+
image::navigation/navigating-openshift-web-console-from-che-dashboard.png[OpenShift web console in the drop-down menu,link="../_images/navigation/navigating-openshift-web-console-from-che-dashboard.png"]

. Click the *OpenShift console* link to open the OpenShift web console.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[id="accessing-{prod-id-short}-from-red-hat-applications-menu_{context}"]
= Accessing {prod-short} from Red Hat Applications menu

This section describes how to access {prod-short} workspaces from the *Red Hat Applications* menu on OpenShift Container Platform.
This section describes how to access {prod-short} workspaces from the *Red Hat Applications* menu on the OpenShift Container Platform.

.Prerequisites

Expand Down

0 comments on commit 81118eb

Please sign in to comment.