Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Adding 'Integrating with Kubernetes' user guide #2250

Merged
merged 1 commit into from
Mar 31, 2022
Merged

docs: Adding 'Integrating with Kubernetes' user guide #2250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified ...les/end-user-guide/images/installation/che-red-hat-application-menu-che-odp.png
View file
Open in desktop
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 modules/end-user-guide/images/integration/token-injection.png
View file
Open in desktop
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 ...guide/images/navigation/navigating-openshift-web-console-from-che-dashboard.png
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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.
themr0c marked this conversation as resolved.
Show resolved Hide resolved

. 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.
ibuziuk marked this conversation as resolved.
Show resolved Hide resolved

+
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
View file
Open in desktop
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[]
3 changes: 1 addition & 2 deletions ...s/end-user-guide/pages/navigating-che-from-openshift-developer-perspective.adoc
View file
Open in desktop
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
24 changes: 24 additions & 0 deletions modules/end-user-guide/pages/navigating-openshift-web-console-from-che.adoc
View file
Open in desktop
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}.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The OS web console.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we do not use such contractions I believe - the official naming is OpenShift web console

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't mean to contract, I meant to add an article.

ibuziuk marked this conversation as resolved.
Show resolved Hide resolved

.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.
themr0c marked this conversation as resolved.
Show resolved Hide resolved
+
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.
themr0c marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion .../end-user-guide/partials/proc_accessing-che-from-red-hat-applications-menu.adoc
View file
Open in desktop
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